diff --git a/cache/api.github.com/webhook-events-and-payloads.html b/cache/api.github.com/webhook-events-and-payloads.html index 9ada3c76b..c4d40c2b9 100644 --- a/cache/api.github.com/webhook-events-and-payloads.html +++ b/cache/api.github.com/webhook-events-and-payloads.html @@ -1,18575 +1,18565 @@
-

Webhook events and payloads

+ +
+
+

Webhook events and payloads

-
-

In this article

-
-
  • - -
    - check_run +
    +

    + check_run +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: The 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. +

    - -
    • +

    Availability for check_run

    + +

    Webhook payload object for check_run

    +
    +
    + +
    +
    +
    +

    A check run was completed, and a conclusion is available.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    action string
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    + check_run object + Required +
    +
    +
    +

    + A check performed on the code of a given code + change +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - check_suite +
    +

    + check_suite +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: The 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. +

    - -
    • +

    Availability for check_suite

    + +

    Webhook payload object for check_suite

    +
    +
    + +
    +
    +
    +

    + All check runs in a check suite have completed, and a conclusion + is available. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    + check_suite object + Required +
    +
    +
    +

    + The + check_suite. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - code_scanning_alert +
    +

    + code_scanning_alert +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Code scanning alerts" repository + permission. +

    - -
    • +

    Availability for code_scanning_alert

    + +

    Webhook payload object for code_scanning_alert

    +
    +
    + +
    +
    +
    +

    + 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. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: appeared_in_branch +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +

    + The code scanning alert involved in the event. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + commit_oid string + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - commit_comment +
    +

    + commit_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for commit_comment

    + +

    Webhook payload object for commit_comment

    +

    Someone commented on a commit.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +

    + The action performed. Can be created. +

    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +

    + The + commit comment + resource. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - create +
    +

    + create +

    +
    +
    +

    This event occurs when a Git branch or tag is created.

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    +

    Notes:

    +
      +
    • + This event will not occur when more than three tags are + created at once. +
      • +
    • + Payloads are capped at 25 MB. If an event generates a larger + payload, GitHub will not deliver a payload for that webhook + event. This may happen, for example, if many branches or tags + are pushed at once. We suggest monitoring your payload size to + ensure delivery. +
      • +
    - -
    • +

    Availability for create

    + +

    Webhook payload object for create

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + description string or null + Required +
    +
    +
    +

    The repository's current description.

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + master_branch string + Required +
    +
    +
    +

    + The name of the repository's default branch + (usually main). +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pusher_type string + Required +
    +
    +
    +

    + The pusher type for the event. Can be either + user or a deploy key. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + The + git ref + resource. +

    +
    +
    +
    +
    +
    +
    +
    + ref_type string + Required +
    +
    +
    +

    + The type of Git ref object created in the + repository. +

    +
    +
    +

    + Can be one of: tag, branch +

    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - delete +
    +

    + custom_property +

    +
    +
    +

    + This event occurs when there is activity relating to a custom + property. +

    +

    + For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Custom properties" organization + permission. +

    - -
    • +

    Availability for custom_property

    + +

    Webhook payload object for custom_property

    +
    +
    + +
    +
    +

    A new custom property was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + definition object + Required +
    +
    +
    +

    Custom property defined on an organization

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - dependabot_alert +
    +

    + custom_property_values +

    +
    +
    +

    + This event occurs when there is activity relating to custom + property values for a repository. +

    +

    + For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Custom properties" organization + permission. +

    - -
    • +

    Availability for custom_property_values

    + +

    + Webhook payload object for custom_property_values +

    +
    +

    The custom property values of a repository were updated.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: updated +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + new_property_values + array of objects Required +
    +
    +
    +

    + The new custom property values for the repository. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + old_property_values + array of objects Required +
    +
    +
    +

    + The old custom property values for the repository. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
  • - -
    - deploy_key +
    +

    + delete +

    +
    +
    +

    + This event occurs when a Git branch or tag is deleted. To + subscribe to all pushes to a repository, including branch 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. +

    +

    + Note: This event will not occur when more than + three tags are deleted at once. +

    - -
    • +

    Availability for delete

    + +

    Webhook payload object for delete

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pusher_type string + Required +
    +
    +
    +

    + The pusher type for the event. Can be either + user or a deploy key. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + The + git ref + resource. +

    +
    +
    +
    +
    +
    +
    +
    + ref_type string + Required +
    +
    +
    +

    + The type of Git ref object deleted in the + repository. +

    +
    +
    +

    + Can be one of: tag, branch +

    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - deployment +
    +

    + dependabot_alert +

    +
    +
    +

    + This event occurs when there is activity relating to Dependabot + alerts. +

    +

    + For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Dependabot alerts" repository + permission. +

    +

    + Note: Webhook events for Dependabot alerts are + currently in beta and subject to change. +

    - -
    • +

    Availability for dependabot_alert

    + +

    Webhook payload object for dependabot_alert

    +
    +
    + +
    +
    +
    +

    + A Dependabot alert was automatically closed by a Dependabot + auto-triage rule. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: auto_dismissed +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +

    A Dependabot alert.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - deployment_review +
    +

    + deploy_key +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Deployments" repository permission. +

    - -
    • +

    Availability for deploy_key

    + +

    Webhook payload object for deploy_key

    +
    +
    + +
    +
    +

    A deploy key was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + key object + Required +
    +
    +
    +

    + The + deploy key + resource. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - deployment_status +
    +

    + deployment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for deployment

    + +

    Webhook payload object for deployment

    +

    A deployment was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + deployment object + Required +
    +
    +
    +

    + The + deployment. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
  • - -
    - discussion +
    +

    + deployment_protection_rule +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Deployments" repository permission. +

    - -
    • +

    Availability for deployment_protection_rule

    + +

    + Webhook payload object for deployment_protection_rule +

    +
    +

    + A deployment protection rule was requested for an environment. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    action string
    +
    +
    +
    +

    + Value: requested +

    +
    +
    +
    +
    +
    +
    environment string
    +
    +
    +

    + The name of the environment that has the + deployment protection rule. +

    +
    +
    +
    +
    +
    +
    +
    event string
    +
    +
    +

    + The event that triggered the deployment protection + rule. +

    +
    +
    +
    +
    +
    +
    +
    + deployment_callback_url + string +
    +
    +
    +

    + The URL to review the deployment protection rule. +

    +
    +
    +
    +
    +
    +
    +
    deployment object
    +
    +
    +

    + A request for a specific ref(branch,sha,tag) to be + deployed +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + pull_requests + array of objects +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - discussion_comment +
    +

    + deployment_review +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for deployment_review

    + +

    Webhook payload object for deployment_review

    +
    +
    + +
    +
    +

    A deployment review was approved.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: approved +

    +
    +
    +
    +
    +
    +
    approver object
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    comment string
    +
    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + reviewers array of objects +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + since string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + workflow_job_run object +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_job_runs + array of objects +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
  • - -
    - fork +
    +

    + deployment_status +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for deployment_status

    + +

    Webhook payload object for deployment_status

    +

    A new deployment status was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + check_run object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + deployment object + Required +
    +
    +
    +

    + The + deployment. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + deployment_status object + Required +
    +
    +
    +

    + The + deployment status. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
  • - -
    - github_app_authorization +
    +

    + discussion +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for GitHub Discussions are + currently in beta and subject to change. +

    - -
    • +

    Availability for discussion

    + +

    Webhook payload object for discussion

    +
    +
    + +
    +
    +
    +

    A comment on the discussion was marked as the answer.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: answered +

    +
    +
    +
    +
    +
    +
    + answer object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + discussion object + Required +
    +
    +

    A Discussion in a repository.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - gollum +
    +

    + discussion_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for GitHub Discussions are + currently in beta and subject to change. +

    - -
    • +

    Availability for discussion_comment

    + +

    Webhook payload object for discussion_comment

    +
    +
    + +
    +
    +

    A comment on a discussion was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + discussion object + Required +
    +
    +

    A Discussion in a repository.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - installation +
    +

    + fork +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    - -
    • +

    Availability for fork

    + +

    Webhook payload object for fork

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + forkee object + Required +
    +
    +
    +

    + The created + repository + resource. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - installation_repositories +
    +

    + github_app_authorization +

    +
    +
    +

    + 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. +

    +

    + A GitHub App receives this webhook by default and cannot + unsubscribe from this event. +

    +

    + Anyone 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." +

    - -
    • +

    Availability for github_app_authorization

    + +

    + Webhook payload object for github_app_authorization +

    +
    +

    Someone revoked their authorization of a GitHub App.

    +
    +
    + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: revoked +

    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - issue_comment +
    +

    + gollum +

    +
    +
    +

    + This event occurs when someone creates or updates a wiki page. + For more information, see "About wikis." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    - -
    • +

    Availability for gollum

    + +

    Webhook payload object for gollum

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pages array of objects + Required +
    +
    +

    The pages that were updated.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - issues +
    +

    + installation +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for installation

    + +

    Webhook payload object for installation

    +
    +
    + +
    +
    +
    +

    + Someone installed a GitHub App on a user or organization + account. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +

    Installation

    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repositories + array of objects +
    +
    +
    +

    + An array of repository objects that the + installation can access. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + requester object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - label +
    +

    + installation_repositories +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for installation_repositories

    + +

    + Webhook payload object for installation_repositories +

    +
    +
    + +
    +
    +
    +

    + A GitHub App installation was granted access to one or more + repositories. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +

    Installation

    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repositories_added + array of objects Required +
    +
    +
    +

    + An array of repository objects, which were added + to the installation. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repositories_removed + array of objects Required +
    +
    +
    +

    + An array of repository objects, which were removed + from the installation. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + repository_selection string + Required +
    +
    +
    +

    + Describe whether all repositories have been + selected or there's a selection involved +

    +
    +
    +

    + Can be one of: all, selected +

    +
    +
    +
    +
    +
    +
    + requester object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - marketplace_purchase +
    +

    + installation_target +

    +
    +
    +

    + 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. +

    - -
    • +

    Availability for installation_target

    + +

    Webhook payload object for installation_target

    +
    +

    + Somebody renamed the user or organization account that a GitHub + App is installed on. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + account object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: renamed +

    +
    +
    +
    +
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + target_type string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - member +
    +

    + issue_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for issue_comment

    + +

    Webhook payload object for issue_comment

    +
    +
    + +
    +
    +

    A comment on an issue or pull request was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +

    + The + comment + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + issue object + Required +
    +
    +
    +

    + The + issue + the comment belongs to. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - membership +
    +

    + issues +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for issues

    + +

    Webhook payload object for issues

    +
    +
    + +
    +
    +

    An issue was assigned to a user.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +

    The action that was performed.

    +
    +

    + Value: assigned +

    +
    +
    +
    +
    +
    +
    + assignee object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + issue object + Required +
    +
    +
    +

    + The + issue + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - merge_group +
    +

    + label +

    +
    +
    +

    + 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. +

    +

    + If 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. +

    - -
    • +

    Availability for label

    + +

    Webhook payload object for label

    +
    +
    + +
    +
    +

    A label was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + label object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - meta +
    +

    + marketplace_purchase +

    +
    +
    +

    + This event occurs when there is activity relating to a GitHub + Marketplace purchase. For more information, see "GitHub Marketplace." For information about the APIs to manage GitHub Marketplace + listings, see + the GraphQL documentation + or "GitHub Marketplace" in the REST API documentation. +

    - -
    • +

    Availability for marketplace_purchase

    + +

    + Webhook payload object for marketplace_purchase +

    +
    +
    + +
    +
    +
    +

    + Someone cancelled a GitHub Marketplace plan, and the last + billing cycle has ended. The change will take effect on the + account immediately. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: cancelled +

    +
    +
    +
    +
    +
    +
    + effective_date string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + marketplace_purchase object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + previous_marketplace_purchase + object +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - milestone +
    +

    + member +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Members" organization permission. +

    - -
    • +

    Availability for member

    + +

    Webhook payload object for member

    +
    +
    + +
    +
    +
    +

    A GitHub user accepted an invitation to a repository.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added +

    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + member object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - organization +
    +

    + membership +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Members" organization permission. +

    - -
    • +

    Availability for membership

    + +

    Webhook payload object for membership

    +
    +
    + +
    +
    +

    An organization member was added to a team.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + member object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + scope string + Required +
    +
    +
    +

    + The scope of the membership. Currently, can only + be team. +

    +
    +
    +

    + Value: team +

    +
    +
    +
    +
    +
    +
    + sender object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + team object + Required +
    +
    +
    +

    + Groups of organization members that gives + permissions on specified repositories. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
  • - -
    - org_block +
    +

    + merge_group +

    +
    +
    +

    + This event occurs when there is activity relating to a merge + group in a merge queue. For more information, see "Managing a merge queue." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Merge queues" repository permission. +

    - -
    • +

    Availability for merge_group

    + +

    Webhook payload object for merge_group

    +
    +
    + +
    +
    +
    +

    + Status checks were requested for a merge group. This happens + when a merge group is created or added to by the merge queue + because a pull request was queued. +

    +

    + When you receive this event, you should perform checks on the + head SHA and report status back using check runs or commit + statuses. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: checks_requested +

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + merge_group object + Required +
    +
    +
    +

    + A group of pull requests that the merge queue has + grouped together to be merged. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - package +
    +

    + meta +

    +
    +
    +

    + This event occurs when there is activity relating to a webhook + itself. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Meta" app permission. +

    - -
    • +

    Availability for meta

    + +

    Webhook payload object for meta

    +

    The webhook was deleted.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: deleted +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + hook object + Required +
    +
    +
    +

    + The modified webhook. This will contain different + keys based on the type of webhook it is: + repository, organization, business, app, or GitHub + Marketplace. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + hook_id integer + Required +
    +
    +

    The id of the modified webhook.

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - page_build +
    +

    + milestone +

    +
    +
    +

    + 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. +

    +

    + If 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. +

    - -
    • +

    Availability for milestone

    + +

    Webhook payload object for milestone

    +
    +
    + +
    +
    +

    A milestone was closed.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: closed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + milestone object + Required +
    +
    +
    +

    + A collection of related issues and pull requests. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - ping +
    +

    + org_block +

    +
    +
    +

    + This event occurs when organization owners or moderators block + or unblock a non-member from collaborating on the organization's + repositories. For more information, see "Blocking a user from your organization." For information about the APIs to manage blocked users, see + the GraphQL documentation + or "Blocking users" in the REST API documentation. +

    +

    + If you want to receive an event when members are added or + removed from an organization, use the + organization event instead. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" organization + permission. +

    - -
    • +

    Availability for org_block

    + +

    Webhook payload object for org_block

    +
    +
    + +
    +
    +

    A user was blocked from the organization.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: blocked +

    +
    +
    +
    +
    +
    +
    + blocked_user object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - project +
    +

    + organization +

    +
    +
    +

    + 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. +

    +

    + If 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. +

    - -
    • +

    Availability for organization

    + +

    Webhook payload object for organization

    +
    +
    + +
    +
    +

    An organization was deleted.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: deleted +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    membership object
    +
    +
    +

    + The membership between the user and the + organization. Not present when the action is + member_invited. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - project_card +
    +

    + package +

    +
    +
    +

    + 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. +

    +

    + To install this event on a GitHub App, the app must have at + least read-level access for the "Packages" repository + permission. +

    - -
    • +

    Availability for package

    + +

    Webhook payload object for package

    +
    +
    + +
    +
    +

    A package was published to a registry.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + package object + Required +
    +
    +

    Information about the package.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - project_column +
    +

    + page_build +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Pages" repository permission. +

    - -
    • +

    Availability for page_build

    + +

    Webhook payload object for page_build

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + build object + Required +
    +
    +
    +

    + The + List GitHub Pages builds + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + id integer + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - projects_v2_item +
    +

    + personal_access_token_request +

    +
    +
    +

    + 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." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Personal access token requests" + organization permission. +

    +

    + Note: Fine-grained PATs are in public beta. + Related APIs, events, and functionality are subject to change. +

    - -
    • +

    Availability for personal_access_token_request

    + +

    + Webhook payload object for + personal_access_token_request +

    +
    +
    + +
    +
    +
    +

    A fine-grained personal access token request was approved.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: approved +

    +
    +
    +
    +
    +
    +
    + personal_access_token_request + object Required +
    +
    +
    +

    Details of a Personal Access Token Request.

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - public +
    +

    + ping +

    +
    +
    +

    + This event occurs when you create a new webhook. The ping event + is a confirmation from GitHub that you configured the webhook + correctly. +

    - -
    • +

    Availability for ping

    + +

    Webhook payload object for ping

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    hook object
    +
    +

    The webhook that is being pinged

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    hook_id integer
    +
    +
    +

    + The ID of the webhook that triggered the ping. +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    zen string
    +
    +

    Random string of GitHub zen.

    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - pull_request +
    +

    + project_card +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for project_card

    + +

    Webhook payload object for project_card

    +
    +
    + +
    +
    +
    +

    A note in a project (classic) was converted to an issue.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: converted +

    +
    +
    +
    +
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + project_card object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - pull_request_review +
    +

    + project +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for project

    + +

    Webhook payload object for project

    +
    +
    + +
    +
    +

    A project (classic) was closed.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: closed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + project object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - pull_request_review_comment +
    +

    + project_column +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for project_column

    + +

    Webhook payload object for project_column

    +
    +
    + +
    +
    +

    A column was added to a project (classic).

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + project_column object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - pull_request_review_thread +
    +

    + projects_v2 +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for projects are currently + in beta and subject to change. To share feedback about projects + webhooks with GitHub, see the + Projects webhook feedback discussion. +

    - -
    • +

    Availability for projects_v2

    + +

    Webhook payload object for projects_v2

    +
    +
    + +
    +
    +

    A project in the organization was closed.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: closed +

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + projects_v2 object + Required +
    +
    +

    A projects v2 project

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - push +
    +

    + projects_v2_item +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for projects are currently + in beta and subject to change. To share feedback about projects + webhooks with GitHub, see the + Projects webhook feedback discussion. +

    - -
    • +

    Availability for projects_v2_item

    + +

    Webhook payload object for projects_v2_item

    +
    +
    + +
    +
    +
    +

    + An item on an organization project was archived. For more + information, see "Archiving items from your project." +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: archived +

    +
    +
    +
    +
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + projects_v2_item object + Required +
    +
    +

    An item belonging to a project

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - release +
    +

    + projects_v2_status_update +

    +
    +
    +

    + This event occurs when there is activity relating to a status + update on an organization-level project. For more information, + see "About Projects." +

    +

    + For activity relating to a project, use the + projects_v2 event. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Projects" organization permission. +

    +

    + Note: To share feedback about projects webhooks + with GitHub, see the + Projects webhook feedback discussion. +

    - -
    • +

    Availability for projects_v2_status_update

    + +

    + Webhook payload object for projects_v2_status_update +

    +
    +
    + +
    +
    +
    +

    A status update was added to a project in the organization.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + projects_v2_status_update + object Required +
    +
    +
    +

    An status update belonging to a project

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - repository_dispatch +
    +

    + public +

    +
    +
    +

    + This event occurs when repository visibility changes from + private to public. For more information, see "Setting repository visibility." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    - -
    • +

    Availability for public

    + +

    Webhook payload object for public

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - repository +
    +

    + pull_request +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for pull_request

    + +

    Webhook payload object for pull_request

    +
    +
    + +
    +
    +

    A pull request was assigned to a user.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: assigned +

    +
    +
    +
    +
    +
    +
    + assignee object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + number integer + Required +
    +
    +

    The pull request number.

    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - repository_import +
    +

    + pull_request_review_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for pull_request_review_comment

    + +

    + Webhook payload object for + pull_request_review_comment +

    +
    +
    + +
    +
    +

    A comment on a pull request diff was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +

    + The + comment + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - repository_vulnerability_alert +
    +

    + pull_request_review +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for pull_request_review

    + +

    Webhook payload object for pull_request_review

    +
    +
    + +
    +
    +

    A review on a pull request was dismissed.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: dismissed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + review object + Required +
    +
    +

    The review that was affected.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - security_advisory +
    +

    + pull_request_review_thread +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    - -
    • +

    Availability for pull_request_review_thread

    + +

    + Webhook payload object for pull_request_review_thread +

    +
    +
    + +
    +
    +
    +

    A comment thread on a pull request was marked as resolved.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: resolved +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + thread object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
  • - -
    - sponsorship +
    +

    + push +

    +
    +
    +

    + 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, when a branch is deleted, when a tag is deleted, or when + a repository is created from a template. To subscribe to only + branch and 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. +

    +

    + Note: Events 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. +

    - -
    • +

    Availability for push

    + +

    Webhook payload object for push

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + after string + Required +
    +
    +
    +

    + The SHA of the most recent commit on + ref after the push. +

    +
    +
    +
    +
    +
    +
    +
    + base_ref string or null + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + before string + Required +
    +
    +
    +

    + The SHA of the most recent commit on + ref before the push. +

    +
    +
    +
    +
    +
    +
    +
    + commits array of objects + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + compare string + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    + created boolean + Required +
    +
    +
    +

    + Whether this push created the ref. +

    +
    +
    +
    +
    +
    +
    +
    + deleted boolean + Required +
    +
    +
    +

    + Whether this push deleted the ref. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + forced boolean + Required +
    +
    +
    +

    + Whether this push was a force push of the + ref. +

    +
    +
    +
    +
    +
    +
    +
    + head_commit object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pusher object + Required +
    +
    +
    +

    + Metaproperties for Git author/committer + information. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + The full git ref that was pushed. Example: + refs/heads/main or + refs/tags/v3.14.1. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +

    A git repository

    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - star +
    +

    + registry_package +

    +
    +
    +

    + 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. +

    +

    + To install this event on a GitHub App, the app must have at + least read-level access for the "Packages" repository + permission. +

    +

    + Note: GitHub recommends that you use the newer + package event instead. +

    - -
    • +

    Availability for registry_package

    + +

    Webhook payload object for registry_package

    +
    +
    + +
    +
    +

    A package was published to a registry.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + registry_package object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - status +
    +

    + release +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    - -
    • +

    Availability for release

    + +

    Webhook payload object for release

    +
    +
    + +
    +
    +
    +

    + A draft was saved, or a release or pre-release was published + without previously being saved as a draft. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + release object + Required +
    +
    +
    +

    + The + release + object. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - team +
    +

    + repository_advisory +

    +
    +
    +

    + This event occurs when there is activity relating to a + repository security advisory. For more information about + repository security advisories, see "About GitHub Security Advisories for repositories." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Repository security advisories" + permission. +

    - -
    • +

    Availability for repository_advisory

    + +

    Webhook payload object for repository_advisory

    +
    +
    + +
    +
    +

    A repository security advisory was published.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + repository_advisory object + Required +
    +
    +

    A repository security advisory.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - team_add +
    +

    + repository +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    - -
    • +

    Availability for repository

    + +

    Webhook payload object for repository

    +
    +
    + +
    +
    +

    A repository was archived.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: archived +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - watch +
    +

    + repository_dispatch +

    +
    +
    +

    + 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. +

    - -
    • +

    Availability for repository_dispatch

    + +

    Webhook payload object for repository_dispatch

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +

    + The event_type that was specified in + the + POST /repos/{owner}/{repo}/dispatches + request body. +

    +
    +
    +
    +
    +
    +
    +
    + branch string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + client_payload + object or null Required +
    +
    +
    +

    + The client_payload that was specified + in the + POST /repos/{owner}/{repo}/dispatches + request body. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - workflow_dispatch +
    +

    + repository_import +

    +
    +
    +

    + This event occurs when a repository is imported to GitHub. For + more information, see "Importing a repository with GitHub Importer." For more information about the API to manage imports, see + the REST API documentation. +

    - -
    • +

    Availability for repository_import

    + +

    Webhook payload object for repository_import

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + status string + Required +
    +
    +
    +
    +

    + Can be one of: success, cancelled, failure +

    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - workflow_job +
    +

    + repository_ruleset +

    +
    +
    +

    + This event occurs when there is activity relating to repository + rulesets. For more information about repository rulesets, see + "Managing rulesets." For 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." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository or + organization permission. +

    - -
    • +

    Availability for repository_ruleset

    + +

    Webhook payload object for repository_ruleset

    +
    +
    + +
    +
    +

    A repository ruleset was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + repository_ruleset object + Required +
    +
    +
    +

    + A set of rules to apply when specified conditions + are met. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -
  • - -
    - workflow_run +
    +

    + repository_vulnerability_alert +

    +
    +
    +

    + This event occurs when there is activity relating to a security + vulnerability alert in a repository. +

    +

    + Note: This event is deprecated. Use the + dependabot_alert event instead. +

    - -
    • +

    + Availability for repository_vulnerability_alert +

    + +

    + Webhook payload object for + repository_vulnerability_alert +

    +
    +
    + +
    +
    +

    A repository vulnerability alert was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: create +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +

    + The security alert of the vulnerable dependency. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + - - - -
    -
    -

    - For each webhook event, you can review when the event occurs, an example - payload, and descriptions about the payload object parameters. -

    -
    -
    -
    -
    -
    -

    - When configuring a webhook, you can use the UI or API to choose which - events will send you payloads. Only subscribing to the specific events - you plan on handling limits the number of HTTP requests to your server. - You can also subscribe to all current and future events. By default, - webhooks are only subscribed to the push event. You can change the list - of subscribed events anytime. -

    -

    - You can create webhooks that subscribe to the events listed on this - page. Each webhook event includes a description of the webhook - properties and an example payload. For more information, see "Creating - webhooks." -

    -

    - - - - Webhook payload object common properties -

    -

    - Each webhook event payload also contains properties unique to the event. - You can find the unique properties in the individual event type - sections. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - Most webhook payloads contain an action property that - contains the specific activity that triggered the event. -
    senderobject - The user that triggered the event. This property is included in - every webhook payload. -
    repositoryobject - The - repository - where the event occurred. Webhook payloads contain the - repository property when the event occurs from - activity in a repository. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. For more information, see "Building - GitHub App." -
    -

    - The unique properties for a webhook event are the same properties you'll - find in the payload property when using the - Events API. One - exception is the push event. The unique - properties of the push event webhook payload and the - payload property in the Events API differ. The webhook - payload contains more detailed information. -

    -

    - Note: Payloads are capped at 25 MB. If your event - generates a larger payload, a webhook will not be fired. This may - happen, for example, on a create event if many branches - or tags are pushed at once. We suggest monitoring your payload size to - ensure delivery. -

    -
    -

    - - - - Delivery headers -

    -

    - HTTP POST payloads that are delivered to your webhook's configured URL - endpoint will contain several special headers: -

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HeaderDescription
    X-GitHub-EventName of the event that triggered the delivery.
    X-GitHub-Delivery - A - GUID - to identify the delivery. -
    X-Hub-Signature - This header is sent if the webhook is configured with a - secret. This is the HMAC hex - digest of the request body, and is - generated using the SHA-1 hash function and the - secret as the HMAC key. - X-Hub-Signature is provided for compatibility with - existing integrations, and we recommend that you use the more - secure X-Hub-Signature-256 instead. -
    X-Hub-Signature-256 - This header is sent if the webhook is configured with a - secret. This is the HMAC hex - digest of the request body, and is - generated using the SHA-256 hash function and the - secret as the HMAC key. -
    -

    - Also, the User-Agent for the requests will have the prefix - GitHub-Hookshot/. -

    -

    - - - - Example delivery -

    - 
    > POST /payload HTTP/2
-
-> Host: localhost:4567
-> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
-> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
-> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
-> User-Agent: GitHub-Hookshot/044aadd
-> Content-Type: application/json
-> Content-Length: 6615
-> X-GitHub-Event: issues
-
-> {
->   "action": "opened",
->   "issue": {
->     "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
->     "number": 1347,
->     ...
->   },
->   "repository" : {
->     "id": 1296269,
->     "full_name": "octocat/Hello-World",
->     "owner": {
->       "login": "octocat",
->       "id": 1,
->       ...
->     },
->     ...
->   },
->   "sender": {
->     "login": "octocat",
->     "id": 1,
->     ...
->   }
-> }
    -

    - - - - branch_protection_rule -

    -

    - Activity related to a branch protection rule. For more information, see - "About - branch protection rules." -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Administration repository permission -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created, - edited, or deleted. -
    ruleobject - 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. -
    changesobject - If the action was edited, the changes to the rule. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "edited",
-  "rule": {
-    "id": 21796960,
-    "repository_id": 259377789,
-    "name": "production",
-    "created_at": "2021-08-19T12:16:32.000-04:00",
-    "updated_at": "2021-08-19T12:16:32.000-04:00",
-    "pull_request_reviews_enforcement_level": "off",
-    "required_approving_review_count": 1,
-    "dismiss_stale_reviews_on_push": false,
-    "require_code_owner_review": false,
-    "authorized_dismissal_actors_only": false,
-    "ignore_approvals_from_contributors": false,
-    "required_status_checks": [
-      "basic-CI"
-    ],
-    "required_status_checks_enforcement_level": "non_admins",
-    "strict_required_status_checks_policy": false,
-    "signature_requirement_enforcement_level": "off",
-    "linear_history_requirement_enforcement_level": "off",
-    "admin_enforced": false,
-    "allow_force_pushes_enforcement_level": "off",
-    "allow_deletions_enforcement_level": "off",
-    "merge_queue_enforcement_level": "off",
-    "required_deployments_enforcement_level": "off",
-    "required_conversation_resolution_level": "off",
-    "authorized_actors_only": true,
-    "authorized_actor_names": [
-      "Codertocat"
-    ]
-  },
-  "changes": {
-    "authorized_actors_only": {
-      "from": false
-    },
-    "authorized_actor_names": {
-      "from": []
-    }
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +

    + secret_scanning_alert +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for secret_scanning_alert

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for secret_scanning_alert +

    +
    +
    + +
    +
    +

    A secret scanning alert was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - check_run -

    -

    - Check run activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check runs" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    -
    -

    - - - - Availability -

    -
      -
    • - Repository webhooks only receive payloads for the - created and completed event types in a - repository -
      • -
    • - Organization webhooks only receive payloads for the - created and completed event types in - repositories -
      • -
    • - GitHub Apps with Checks read permission receive - payloads for the created and - completed events that occur in the repository where the - app is installed. The app must have Checks write - permission to receive the rerequested and - requested_action event types. The - rerequested and requested_action event type - payloads are only sent to the GitHub App being requested. GitHub Apps - with Checks write permission are automatically - subscribed to this webhook event. -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • created - A new check run was created.
      • -
    • - completed - The status of the check - run is completed. -
      • -
    • - rerequested - Someone requested to re-run your - check run from the pull request UI. See "About - status checks" for more details about the GitHub UI. When you receive a - rerequested action, you'll need to - create a new check run. Only the GitHub App - that someone requests to re-run the - check will receive the rerequested payload. -
      • -
    • - requested_action - Someone requested an action - your app provides to be taken. Only the GitHub App someone - requests to perform an action will receive the - requested_action payload. To learn more about - check runs and requested actions, see "Check runs and requested - actions." -
      • -
    -
    check_runobject - The - check_run. -
    check_run[status]string - The current status of the check run. Can be queued, - in_progress, or completed. -
    check_run[conclusion]string - The result of the completed check run. Can be one of - success, failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_run[name]stringThe name of the check run.
    check_run[check_suite][id]integerThe id of the check suite that this check run is part of.
    check_run[check_suite][pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    check_run[check_suite][deployment]object - A deployment to a repository environment. This will only be - populated if the check run was created by a GitHub Actions - workflow job that references an environment. -
    requested_actionobjectThe action requested by the user.
    requested_action[identifier]string - The integrator reference of the action requested by the user. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "check_run": {
-    "id": 128620228,
-    "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=",
-    "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "external_id": "",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228",
-    "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228",
-    "details_url": "https://octocoders.github.io",
-    "status": "queued",
-    "conclusion": null,
-    "started_at": "2019-05-15T15:21:12Z",
-    "completed_at": null,
-    "output": {
-      "title": null,
-      "summary": null,
-      "text": null,
-      "annotations_count": 0,
-      "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations"
-    },
-    "name": "Octocoders-linter",
-    "check_suite": {
-      "id": 118578147,
-      "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
-      "head_branch": "changes",
-      "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "status": "queued",
-      "conclusion": null,
-      "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
-      "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-      "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "pull_requests": [
-        {
-          "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-          "id": 279147437,
-          "number": 2,
-          "head": {
-            "ref": "changes",
-            "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-            "repo": {
-              "id": 186853002,
-              "url": "https://api.github.com/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          },
-          "base": {
-            "ref": "master",
-            "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-            "repo": {
-              "id": 186853002,
-              "url": "https://api.github.com/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          }
-        }
-      ],
-      "app": {
-        "id": 29310,
-        "node_id": "MDM6QXBwMjkzMTA=",
-        "owner": {
-          "login": "Octocoders",
-          "id": 38302899,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Octocoders",
-          "html_url": "https://github.com/Octocoders",
-          "followers_url": "https://api.github.com/users/Octocoders/followers",
-          "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-          "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-          "repos_url": "https://api.github.com/users/Octocoders/repos",
-          "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "name": "octocoders-linter",
-        "description": "",
-        "external_url": "https://octocoders.github.io",
-        "html_url": "https://github.com/apps/octocoders-linter",
-        "created_at": "2019-04-19T19:36:24Z",
-        "updated_at": "2019-04-19T19:36:56Z",
-        "permissions": {
-          "administration": "write",
-          "checks": "write",
-          "contents": "write",
-          "deployments": "write",
-          "issues": "write",
-          "members": "write",
-          "metadata": "read",
-          "organization_administration": "write",
-          "organization_hooks": "write",
-          "organization_plan": "read",
-          "organization_projects": "write",
-          "organization_user_blocking": "write",
-          "pages": "write",
-          "pull_requests": "write",
-          "repository_hooks": "write",
-          "repository_projects": "write",
-          "statuses": "write",
-          "team_discussions": "write",
-          "vulnerability_alerts": "read"
-        },
-        "events": []
-      },
-      "created_at": "2019-05-15T15:20:31Z",
-      "updated_at": "2019-05-15T15:20:31Z"
-    },
-    "app": {
-      "id": 29310,
-      "node_id": "MDM6QXBwMjkzMTA=",
-      "owner": {
-        "login": "Octocoders",
-        "id": 38302899,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Octocoders",
-        "html_url": "https://github.com/Octocoders",
-        "followers_url": "https://api.github.com/users/Octocoders/followers",
-        "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-        "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-        "repos_url": "https://api.github.com/users/Octocoders/repos",
-        "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.github.io",
-      "html_url": "https://github.com/apps/octocoders-linter",
-      "created_at": "2019-04-19T19:36:24Z",
-      "updated_at": "2019-04-19T19:36:56Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "members": "write",
-        "metadata": "read",
-        "organization_administration": "write",
-        "organization_hooks": "write",
-        "organization_plan": "read",
-        "organization_projects": "write",
-        "organization_user_blocking": "write",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "statuses": "write",
-        "team_discussions": "write",
-        "vulnerability_alerts": "read"
-      },
-      "events": []
-    },
-    "pull_requests": [
-      {
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-        "id": 279147437,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-          "repo": {
-            "id": 186853002,
-            "url": "https://api.github.com/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-          "repo": {
-            "id": 186853002,
-            "url": "https://api.github.com/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "deployment": {
-      "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
-      "id": 326191728,
-      "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
-      "task": "deploy",
-      "original_environment": "lab",
-      "environment": "lab",
-      "description": null,
-      "created_at": "2021-02-18T08:22:48Z",
-      "updated_at": "2021-02-18T09:47:16Z",
-      "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
-      "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
-    }
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +

    + secret_scanning_alert_location +

    +
    +
    +

    + This event occurs when there is activity relating to the + locations of a secret in 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. +

    +

    + For 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. +

    +
    +

    + Availability for secret_scanning_alert_location +

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + secret_scanning_alert_location +

    +
    +

    + 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. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    action string
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + location object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - check_suite -

    -

    - Check suite activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check suites" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    -
    -

    - - - - Availability -

    -
      -
    • - Repository webhooks only receive payloads for the - completed event types in a repository -
      • -
    • - Organization webhooks only receive payloads for the - completed event types in repositories -
      • -
    • - GitHub Apps with Checks read permission receive - payloads for the created and - completed events that occur in the repository where the - app is installed. The app must have Checks write - permission to receive the requested and - rerequested event types. The requested and - rerequested event type payloads are only sent to the - GitHub App being requested. GitHub Apps with - Checks write permission are automatically subscribed - to this webhook event. -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be: -
      -
    • - completed - All check runs in a check suite have - completed. -
      • -
    • - requested - Occurs when new code is pushed to the - app's repository. When you receive the - requested action events, you'll need to - create a new check run. -
      • -
    • - rerequested - Occurs when someone requests to - re-run the entire check suite from the pull request UI. When - you receive the rerequested action events, you'll - need to - create a new check run. See "About status checks" for more details about the - GitHub UI. -
      • -
    -
    check_suiteobject - The check_suite. -
    check_suite[head_branch]stringThe head branch name the changes are on.
    check_suite[head_sha]stringThe SHA of the most recent commit for this check suite.
    check_suite[status]string - The summary status for all check runs that are part of the check - suite. Can be queued, requested, - in_progress, or completed. -
    check_suite[conclusion]string - The summary conclusion for all check runs that are part of the - check suite. Can be one of success, - failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_suite[url]stringURL that points to the check suite API resource.
    check_suite[pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "check_suite": {
-    "id": 118578147,
-    "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
-    "head_branch": "changes",
-    "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "status": "completed",
-    "conclusion": "success",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
-    "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "pull_requests": [
-      {
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-        "id": 279147437,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-          "repo": {
-            "id": 186853002,
-            "url": "https://api.github.com/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-          "repo": {
-            "id": 186853002,
-            "url": "https://api.github.com/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "app": {
-      "id": 29310,
-      "node_id": "MDM6QXBwMjkzMTA=",
-      "owner": {
-        "login": "Octocoders",
-        "id": 38302899,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Octocoders",
-        "html_url": "https://github.com/Octocoders",
-        "followers_url": "https://api.github.com/users/Octocoders/followers",
-        "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-        "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-        "repos_url": "https://api.github.com/users/Octocoders/repos",
-        "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.github.io",
-      "html_url": "https://github.com/apps/octocoders-linter",
-      "created_at": "2019-04-19T19:36:24Z",
-      "updated_at": "2019-04-19T19:36:56Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "members": "write",
-        "metadata": "read",
-        "organization_administration": "write",
-        "organization_hooks": "write",
-        "organization_plan": "read",
-        "organization_projects": "write",
-        "organization_user_blocking": "write",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "statuses": "write",
-        "team_discussions": "write",
-        "vulnerability_alerts": "read"
-      },
-      "events": []
-    },
-    "created_at": "2019-05-15T15:20:31Z",
-    "updated_at": "2019-05-15T15:21:14Z",
-    "latest_check_runs_count": 1,
-    "check_runs_url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147/check-runs",
-    "head_commit": {
-      "id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
-      "message": "Update README.md",
-      "timestamp": "2019-05-15T15:20:30Z",
-      "author": {
-        "name": "Codertocat",
-        "email": "21031067+Codertocat@users.noreply.github.com"
-      },
-      "committer": {
-        "name": "Codertocat",
-        "email": "21031067+Codertocat@users.noreply.github.com"
-      }
-    }
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:14Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - code_scanning_alert -

    -

    - Activity related to code scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see "About code - scanning." -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Code scanning alerts permission -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - created, reopened_by_user, - closed_by_user, fixed, - appeared_in_branch, or reopened. -
    alertobjectThe code scanning alert involved in the event.
    refstring - 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. -
    commit_oidstring - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is reopened_by_user or - closed_by_user, the sender object will - be the user that triggered the event. The - sender object is github for all other - actions. -
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 10,
-    "created_at": "2020-07-22T14:06:31Z",
-    "updated_at": "2020-07-22T14:06:31Z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/code-scanning/alerts/10",
-    "html_url": "https://github.com/Codertocat/Hello-World/security/code-scanning/10",
-    "instances": [
-      {
-        "ref": "refs/heads/main",
-        "analysis_key": ".github/workflows/workflow.yml:upload",
-        "environment": "{}",
-        "state": "open"
-      }
-    ],
-    "state": "open",
-    "fixed_at": null,
-    "dismissed_by": null,
-    "dismissed_at": null,
-    "dismissed_reason": null,
-    "rule": {
-      "id": "Style/FrozenStringLiteralComment",
-      "severity": "note",
-      "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.",
-      "full_description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.",
-      "tags": [
-        "style"
-      ],
-      "help": "Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged\n--- | --- | --- | --- | ---\nEnabled | No | Yes (Unsafe) | 0.36 | 0.79\n\nThis cop is designed to help you transition from mutable string literals\nto frozen string literals.\nIt will add the comment `# frozen_string_literal: true` to the top of\nfiles to enable frozen string literals. Frozen string literals may be\ndefault in future Ruby. The comment will be added below a shebang and\nencoding comment. The frozen string literal comment is only valid in\nRuby 2.3+.\n\nNote that the cop will ignore files where the comment exists but is set\nto `false` instead of `true`.\n\n### Examples\n\n#### EnforcedStyle: always (default)\n\n```ruby\n# The `always` style will always add the frozen string literal comment\n# to a file, regardless of the Ruby version or if `freeze` or `<<` are\n# called on a string literal.\n# bad\nmodule Bar\n  # ...\nend\n\n# good\n# frozen_string_literal: true\n\nmodule Bar\n  # ...\nend\n\n# good\n# frozen_string_literal: false\n\nmodule Bar\n  # ...\nend\n```\n#### EnforcedStyle: never\n\n```ruby\n# The `never` will enforce that the frozen string literal comment does\n# not exist in a file.\n# bad\n# frozen_string_literal: true\n\nmodule Baz\n  # ...\nend\n\n# good\nmodule Baz\n  # ...\nend\n```\n#### EnforcedStyle: always_true\n\n```ruby\n# The `always_true` style enforces that the frozen string literal\n# comment is set to `true`. This is a stricter option than `always`\n# and forces projects to use frozen string literals.\n# bad\n# frozen_string_literal: false\n\nmodule Baz\n  # ...\nend\n\n# bad\nmodule Baz\n  # ...\nend\n\n# good\n# frozen_string_literal: true\n\nmodule Bar\n  # ...\nend\n```\n\n### Configurable attributes\n\nName | Default value | Configurable values\n--- | --- | ---\nEnforcedStyle | `always` | `always`, `always_true`, `never`\n\n"
-    },
-    "tool": {
-      "name": "Rubocop",
-      "version": null
-    }
-  },
-  "ref": "refs/heads/main",
-  "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars0.githubusercontent.com/u/6?",
-    "description": ""
-  },
-  "sender": {
-    "login": "github",
-    "id": 9919,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
-    "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/github",
-    "html_url": "https://github.com/github",
-    "followers_url": "https://api.github.com/users/github/followers",
-    "following_url": "https://api.github.com/users/github/following{/other_user}",
-    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
-    "organizations_url": "https://api.github.com/users/github/orgs",
-    "repos_url": "https://api.github.com/users/github/repos",
-    "events_url": "https://api.github.com/users/github/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/github/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - commit_comment -

    -

    - A commit comment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "commit comment" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    commentobject - The - commit comment - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/comments/33548674",
-    "html_url": "https://github.com/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246#commitcomment-33548674",
-    "id": 33548674,
-    "node_id": "MDEzOkNvbW1pdENvbW1lbnQzMzU0ODY3NA==",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "position": null,
-    "line": null,
-    "path": null,
-    "commit_id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "created_at": "2019-05-15T15:20:39Z",
-    "updated_at": "2019-05-15T15:20:39Z",
-    "author_association": "OWNER",
-    "body": "This is a really good change! :+1:"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:34Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +

    + security_advisory +

    +
    +
    +

    + 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. +

    +

    + GitHub Dependabot alerts are also powered by the security + advisory dataset. For more information, see "About Dependabot alerts." +

    +
    +

    Availability for security_advisory

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for security_advisory

    +
    +
    + +
    +
    +
    +

    A security advisory was published to the GitHub community.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + security_advisory object + Required +
    +
    +
    +

    + The details of the security advisory, including + summary, description, and severity. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - create -

    -

    - A Git branch or tag is created. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you create more than three tags at once. -

    -
    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The - git ref - resource. -
    ref_typestring - The type of Git ref object created in the repository. Can be - either branch or tag. -
    master_branchstring - The name of the repository's default branch (usually - main). -
    descriptionstringThe repository's current description.
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "master_branch": "master",
-  "description": null,
-  "pusher_type": "user",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:56Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +

    + security_and_analysis +

    +
    +
    +

    + This event occurs when code security and analysis features are + enabled or disabled for a repository. For more information, see + "GitHub security features." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository + permission. +

    +
    +

    Availability for security_and_analysis

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for security_and_analysis +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +

    Full Repository

    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - delete -

    -

    - A Git branch or tag is deleted. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you delete more than three tags at once. -

    -
    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The - git ref - resource. -
    ref_typestring - The type of Git ref object deleted in the repository. Can be - either branch or tag. -
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "pusher_type": "user",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +

    + sponsorship +

    +
    +
    +

    + 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. +

    +

    + You can only create a sponsorship webhook on GitHub.com. For + more information, see "Configuring webhooks for events in your sponsored account." +

    +
    +

    Availability for sponsorship

    +
      +
    • Sponsored accounts
      • +
    +

    Webhook payload object for sponsorship

    +
    +
    + +
    +
    +
    +

    + A sponsorship was cancelled and the last billing cycle has + ended. +

    +

    + This event is only sent when a recurring (monthly) sponsorship + is cancelled; it is not sent for one-time sponsorships. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: cancelled +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + sponsorship object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -

    - - - - dependabot_alert -

    -

    - Note: Webhook events for Dependabot alerts are - currently in beta and subject to change. -

    -
    -

    - Activity related to Dependabot alerts. The type of activity is specified - in the action property of the payload object. For more - information, see "About - Dependabot alerts." -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Dependabot alerts permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - dismissed, reopened, fixed, - or reintroduced. -
    alertobject - The Dependabot - alert - involved in the event. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is dismissed or - reopened, the sender is the - user - that triggered the event. The sender is - github for all other actions. -
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "fixed",
-  "alert": {
-    "number": 1,
-    "state": "fixed",
-    "dependency": {
-      "package": {
-        "ecosystem": "pip",
-        "name": "ansible"
-      },
-      "manifest_path": "path/to/requirements.txt",
-      "scope": "runtime"
-    },
-    "security_advisory": {
-      "ghsa_id": "GHSA-8f4m-hccc-8qph",
-      "cve_id": "CVE-2021-20191",
-      "summary": "Insertion of Sensitive Information into Log File in ansible",
-      "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
-      "vulnerabilities": [
-        {
-          "package": {
-            "ecosystem": "pip",
-            "name": "ansible"
-          },
-          "severity": "medium",
-          "vulnerable_version_range": ">= 2.9.0, < 2.9.18",
-          "first_patched_version": {
-            "identifier": "2.9.18"
-          }
-        },
-        {
-          "package": {
-            "ecosystem": "pip",
-            "name": "ansible"
-          },
-          "severity": "medium",
-          "vulnerable_version_range": "< 2.8.19",
-          "first_patched_version": {
-            "identifier": "2.8.19"
-          }
-        },
-        {
-          "package": {
-            "ecosystem": "pip",
-            "name": "ansible"
-          },
-          "severity": "medium",
-          "vulnerable_version_range": ">= 2.10.0, < 2.10.7",
-          "first_patched_version": {
-            "identifier": "2.10.7"
-          }
-        }
-      ],
-      "severity": "medium",
-      "cvss": {
-        "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
-        "score": 5.5
-      },
-      "cwes": [
-        {
-          "cwe_id": "CWE-532",
-          "name": "Insertion of Sensitive Information into Log File"
-        }
-      ],
-      "identifiers": [
-        {
-          "type": "GHSA",
-          "value": "GHSA-8f4m-hccc-8qph"
-        },
-        {
-          "type": "CVE",
-          "value": "CVE-2021-20191"
-        }
-      ],
-      "references": [
-        {
-          "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"
-        },
-        {
-          "url": "https://access.redhat.com/security/cve/cve-2021-20191"
-        },
-        {
-          "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"
-        }
-      ],
-      "published_at": "2021-06-01T17:38:00Z",
-      "updated_at": "2021-08-12T23:06:00Z",
-      "withdrawn_at": null
-    },
-    "security_vulnerability": {
-      "package": {
-        "ecosystem": "pip",
-        "name": "ansible"
-      },
-      "severity": "medium",
-      "vulnerable_version_range": "< 2.8.19",
-      "first_patched_version": {
-        "identifier": "2.8.19"
-      }
-    },
-    "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1",
-    "html_url": "https://github.com/octocat/hello-world/security/dependabot/1",
-    "created_at": "2022-06-14T15:21:52Z",
-    "updated_at": "2022-06-15T13:55:40Z",
-    "dismissed_at": null,
-    "dismissed_by": null,
-    "dismissed_reason": null,
-    "dismissed_comment": null,
-    "fixed_at": "2022-06-15T13:55:40Z"
-  },
-  "repository": {
-    "id": 1296269,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
-    "name": "hello-world",
-    "full_name": "octocat/hello-world",
-    "private": false,
-    "owner": {
-      "login": "octocat",
-      "id": 1,
-      "node_id": "MDQ6VXNlcjE=",
-      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octocat/hello-world",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/octocat/hello-world",
-    "archive_url": "https://api.github.com/repos/octocat/hello-world/{archive_format}{/ref}",
-    "assignees_url": "https://api.github.com/repos/octocat/hello-world/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/octocat/hello-world/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/octocat/hello-world/branches{/branch}",
-    "collaborators_url": "https://api.github.com/repos/octocat/hello-world/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/octocat/hello-world/comments{/number}",
-    "commits_url": "https://api.github.com/repos/octocat/hello-world/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/octocat/hello-world/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/octocat/hello-world/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/octocat/hello-world/contributors",
-    "deployments_url": "https://api.github.com/repos/octocat/hello-world/deployments",
-    "downloads_url": "https://api.github.com/repos/octocat/hello-world/downloads",
-    "events_url": "https://api.github.com/repos/octocat/hello-world/events",
-    "forks_url": "https://api.github.com/repos/octocat/hello-world/forks",
-    "git_commits_url": "https://api.github.com/repos/octocat/hello-world/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octocat/hello-world/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octocat/hello-world/git/tags{/sha}",
-    "issue_comment_url": "https://api.github.com/repos/octocat/hello-world/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/octocat/hello-world/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/octocat/hello-world/issues{/number}",
-    "keys_url": "https://api.github.com/repos/octocat/hello-world/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/octocat/hello-world/labels{/name}",
-    "languages_url": "https://api.github.com/repos/octocat/hello-world/languages",
-    "merges_url": "https://api.github.com/repos/octocat/hello-world/merges",
-    "milestones_url": "https://api.github.com/repos/octocat/hello-world/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octocat/hello-world/notifications{?since,all,participating}",
-    "pulls_url": "https://api.github.com/repos/octocat/hello-world/pulls{/number}",
-    "releases_url": "https://api.github.com/repos/octocat/hello-world/releases{/id}",
-    "stargazers_url": "https://api.github.com/repos/octocat/hello-world/stargazers",
-    "statuses_url": "https://api.github.com/repos/octocat/hello-world/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/octocat/hello-world/subscribers",
-    "subscription_url": "https://api.github.com/repos/octocat/hello-world/subscription",
-    "tags_url": "https://api.github.com/repos/octocat/hello-world/tags",
-    "teams_url": "https://api.github.com/repos/octocat/hello-world/teams",
-    "trees_url": "https://api.github.com/repos/octocat/hello-world/git/trees{/sha}",
-    "hooks_url": "https://api.github.com/repos/octocat/hello-world/hooks",
-    "created_at": "2022-06-07T14:08:11Z",
-    "updated_at": "2022-06-09T16:29:20Z",
-    "pushed_at": "2022-06-08T15:58:49Z",
-    "git_url": "git://github.com/octocat/hello-world.git",
-    "ssh_url": "git@github.com:octocat/hello-world.git",
-    "clone_url": "https://github.com/octocat/hello-world.git",
-    "svn_url": "https://github.com/octocat/hello-world",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Python",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "allow_forking": true,
-    "is_template": false,
-    "web_commit_signoff_required": false,
-    "topics": [],
-    "visibility": "public",
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "sender": {
-    "login": "github",
-    "id": 9919,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
-    "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/github",
-    "html_url": "https://github.com/github",
-    "followers_url": "https://api.github.com/users/github/followers",
-    "following_url": "https://api.github.com/users/github/following{/other_user}",
-    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
-    "organizations_url": "https://api.github.com/users/github/orgs",
-    "repos_url": "https://api.github.com/users/github/repos",
-    "events_url": "https://api.github.com/users/github/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/github/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - deploy_key -

    -

    - A deploy key is added or removed from a repository. The type of activity - is specified in the action property of the payload object. - For more information, see the "Deploy keys" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be either created or - deleted. -
    keyobject - The - deploy key - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "key": {
-    "id": 100,
-    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100",
-    "title": "hey-its-a-deploy-key",
-    "verified": true,
-    "created_at": "2019-04-02T17:37:07Z",
-    "read_only": true
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - deployment -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployment" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Deployments permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deploymentobject - The - deployment. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "deployment": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746",
-    "id": 145988746,
-    "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=",
-    "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T15:20:53Z",
-    "updated_at": "2019-05-15T15:20:53Z",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses",
-    "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:52Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +

    + star +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    +
    +

    Availability for star

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for star

    +
    +
    + +
    +
    +

    Someone starred a repository.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + starred_at string or null + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - deployment_review -

    -

    - - - - deployment_status -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployments" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Deployments permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deployment_statusobject - The - deployment status. -
    deployment_status["state"]string - The new state. Can be pending, success, - failure, or error. -
    deployment_status["target_url"]stringThe optional link added to the status.
    deployment_status["description"]string - The optional human-readable description added to the status. -
    deploymentobject - The - deployment - that this status is associated with. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "deployment_status": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses/209916254",
-    "id": 209916254,
-    "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMyMDk5MTYyNTQ=",
-    "state": "success",
-    "creator": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "description": "",
-    "environment": "production",
-    "target_url": "",
-    "created_at": "2019-05-15T15:20:55Z",
-    "updated_at": "2019-05-15T15:20:55Z",
-    "deployment_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746",
-    "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
-  },
-  "deployment": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746",
-    "id": 145988746,
-    "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=",
-    "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T15:20:53Z",
-    "updated_at": "2019-05-15T15:20:55Z",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses",
-    "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:52Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + status +

    +
    +
    +

    + 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. +

    +
    +

    Availability for status

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for status

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + avatar_url string or null +
    +
    +
    +
    +
    +
    +
    +
    +
    + branches array of objects + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + commit object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + context string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + created_at string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + description string or null + Required +
    +
    +
    +

    + The optional human-readable description added to + the status. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + id integer + Required +
    +
    +

    The unique identifier of the status.

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + name string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + sha string + Required +
    +
    +

    The Commit SHA.

    +
    +
    +
    +
    +
    +
    + state string + Required +
    +
    +
    +

    + The new state. Can be pending, + success, failure, or + error. +

    +
    +
    +

    + Can be one of: pending, success, failure, error +

    +
    +
    +
    +
    +
    +
    + target_url string or null + Required +
    +
    +
    +

    The optional link added to the status.

    +
    +
    +
    +
    +
    +
    +
    + updated_at string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - discussion -

    -

    - Note: Webhook events for GitHub Discussions are - currently in beta and subject to change. -

    +
    +

    + team_add +

    +
    +
    +

    + This event occurs when a team is added to a repository. For more + information, see "Managing teams and people with access to your repository." +

    +

    + For 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. +

    +
    +

    Availability for team_add

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for team_add

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + team object + Required +
    +
    +
    +

    + Groups of organization members that gives + permissions on specified repositories. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -

    - Activity related to a discussion. For more information, see the "Using the GraphQL API for discussions." -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Discussions permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created, - edited, deleted, pinned, - unpinned, locked, unlocked, - transferred, category_changed, - answered, unanswered, - labeled, or unlabeled. -
    discussionobject - The - discussion - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "discussion": {
-    "repository_url": "https://api.github.com/repos/octo-org/octo-repo",
-    "category": {
-      "id": 32784361,
-      "node_id": "DIC_kwAqGA",
-      "repository_id": 17273051,
-      "emoji": ":speech_balloon:",
-      "name": "General",
-      "description": "Chat about anything and everything here",
-      "created_at": "2021-03-24T12:41:54.000-05:00",
-      "updated_at": "2021-03-24T12:41:54.000-05:00",
-      "slug": "general",
-      "is_answerable": false
-    },
-    "answer_html_url": null,
-    "answer_chosen_at": null,
-    "answer_chosen_by": null,
-    "html_url": "https://github.com/octo-org/octo-repo/discussions/90",
-    "id": 3297442,
-    "node_id": "MDEwOkRpc2N1c3Npb24zMjk3NDQy",
-    "number": 90,
-    "title": "Welcome to discussions!",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "state": "open",
-    "locked": false,
-    "comments": 0,
-    "created_at": "2021-03-29T14:16:08Z",
-    "updated_at": "2021-03-29T14:16:08Z",
-    "author_association": "COLLABORATOR",
-    "active_lock_reason": null,
-    "body": "We're glad to have you here!"
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + team +

    +
    +
    +

    + This event occurs when there is activity relating to teams in an + organization. For more information, see "About teams." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Members" organization permission. +

    +
    +

    Availability for team

    +
      +
    • Organizations
      • +
    • Enterprises
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for team

    +
    +
    + +
    +
    +

    A team was granted access to a repository.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added_to_repository +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +

    A git repository

    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + team object + Required +
    +
    +
    +

    + Groups of organization members that gives + permissions on specified repositories. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -

    - - - - discussion_comment -

    -

    - Note: Webhook events for GitHub Discussions are - currently in beta and subject to change. -

    +
    +

    + watch +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    +
    +

    Availability for watch

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for watch

    +

    Someone started watching the repository.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: started +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - Activity related to a comment in a discussion. For more information, see - "Using the GraphQL API for discussions." -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Discussions permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created, - edited, or deleted. -
    commentobject - The - discussion comment - resource. -
    discussionobject - The - discussion - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "id": 544078,
-    "node_id": "MDE3OkRpc2N1c3Npb25Db21tZW50NTQ0MDc4",
-    "html_url": "https://github.com/octo-org/octo-repo/discussions/90#discussioncomment-544078",
-    "parent_id": null,
-    "child_comment_count": 0,
-    "repository_url": "octo-org/octo-repo",
-    "discussion_id": 3297442,
-    "author_association": "COLLABORATOR",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2021-03-29T14:16:31Z",
-    "updated_at": "2021-03-29T14:16:31Z",
-    "body": "I have so many questions to ask you!"
-  },
-  "discussion": {
-    "repository_url": "https://api.github.com/repos/octo-org/octo-repo",
-    "category": {
-      "id": 32784361,
-      "node_id": "DIC_kwAqGA",
-      "repository_id": 17273051,
-      "emoji": ":speech_balloon:",
-      "name": "General",
-      "description": "Chat about anything and everything here",
-      "created_at": "2021-03-24T12:41:54.000-05:00",
-      "updated_at": "2021-03-24T12:41:54.000-05:00",
-      "slug": "general",
-      "is_answerable": false
-    },
-    "answer_html_url": null,
-    "answer_chosen_at": null,
-    "answer_chosen_by": null,
-    "html_url": "https://github.com/octo-org/octo-repo/discussions/90",
-    "id": 3297442,
-    "node_id": "MDEwOkRpc2N1c3Npb24zMjk3NDQy",
-    "number": 90,
-    "title": "Welcome to discussions!",
-    "user": {
-      "login": "Codertocat",
-      "id": 14935376,
-      "node_id": "MDQ6VXNlcjE0OTM1Mzc2",
-      "avatar_url": "https://avatars.githubusercontent.com/u/14935376?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "state": "open",
-    "locked": false,
-    "comments": 1,
-    "created_at": "2021-03-29T14:16:08Z",
-    "updated_at": "2021-03-29T14:16:31Z",
-    "author_association": "COLLABORATOR",
-    "active_lock_reason": null,
-    "body": "We're glad to have you here!"
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + workflow_dispatch +

    +
    +
    +

    + This event occurs when a GitHub Actions workflow is manually + triggered. For more information, see "Manually running a workflow." +

    +

    + For 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. +

    +
    +

    Availability for workflow_dispatch

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for workflow_dispatch

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + inputs object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - - - fork -

    -

    - A user forks a repository. For more information, see the "forks" - REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    forkeeobject - The created - repository - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "forkee": {
-    "id": 186853261,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 38302899,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Octocoders",
-      "html_url": "https://github.com/Octocoders",
-      "followers_url": "https://api.github.com/users/Octocoders/followers",
-      "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-      "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-      "repos_url": "https://api.github.com/users/Octocoders/repos",
-      "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://api.github.com/repos/Octocoders/Hello-World",
-    "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T15:20:42Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Octocoders/Hello-World.git",
-    "ssh_url": "git@github.com:Octocoders/Hello-World.git",
-    "clone_url": "https://github.com/Octocoders/Hello-World.git",
-    "svn_url": "https://github.com/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "public": true
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Octocoders",
-    "html_url": "https://github.com/Octocoders",
-    "followers_url": "https://api.github.com/users/Octocoders/followers",
-    "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-    "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-    "repos_url": "https://api.github.com/users/Octocoders/repos",
-    "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + workflow_job +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for workflow_job

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for workflow_job

    +
    +
    + +
    +
    +
    +

    + 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. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow_job object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    deployment object
    +
    +
    +

    + A request for a specific ref(branch,sha,tag) to be + deployed +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -

    - - - - github_app_authorization -

    -

    - When someone revokes their authorization of a GitHub App, this event - occurs. A GitHub App receives this webhook by default and cannot - unsubscribe from this event. -

    -

    - Anyone 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 user-to-server requests, which require GitHub App - authorization, see "Identifying and - authorizing users for GitHub Apps." -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be revoked.
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "revoked",
-  "sender": {
-    "login": "octocat",
-    "id": 1,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - gollum -

    -

    - A wiki page is created or updated. For more information, see "About wikis." -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    pagesarrayThe pages that were updated.
    pages[][page_name]stringThe name of the page.
    pages[][title]stringThe current page title.
    pages[][action]string - The action that was performed on the page. Can be - created or edited. -
    pages[][sha]stringThe latest commit SHA of the page.
    pages[][html_url]stringPoints to the HTML wiki page.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "pages": [
-    {
-      "page_name": "Home",
-      "title": "Home",
-      "summary": null,
-      "action": "edited",
-      "sha": "6bf911d3801dd1ef957fc6ade5a8d96429e7fa39",
-      "html_url": "https://github.com/Codertocat/Hello-World/wiki/Home"
-    }
-  ],
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:19:26Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "rachmari",
-    "id": 9831992,
-    "node_id": "MDQ6VXNlcjk4MzE5OTI=",
-    "avatar_url": "https://avatars2.githubusercontent.com/u/9831992?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/rachmari",
-    "html_url": "https://github.com/rachmari",
-    "followers_url": "https://api.github.com/users/rachmari/followers",
-    "following_url": "https://api.github.com/users/rachmari/following{/other_user}",
-    "gists_url": "https://api.github.com/users/rachmari/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/rachmari/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/rachmari/subscriptions",
-    "organizations_url": "https://api.github.com/users/rachmari/orgs",
-    "repos_url": "https://api.github.com/users/rachmari/repos",
-    "events_url": "https://api.github.com/users/rachmari/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/rachmari/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - - - installation -

    -

    - Activity related to a GitHub App installation. The type of activity is - specified in the action property of the payload object. For - more information, see the "GitHub App installation" REST API. -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • created - Someone installs a GitHub App.
      • -
    • deleted - Someone uninstalls a GitHub App
      • -
    • - suspend - Someone suspends a GitHub App - installation. -
      • -
    • - unsuspend - Someone unsuspends a GitHub App - installation. -
      • -
    • - new_permissions_accepted - Someone accepts new - permissions for a GitHub App installation. When a GitHub App - owner requests new permissions, the person who installed the - GitHub App must accept the new permissions request. -
      • -
    -
    repositoriesarray - An array of repository objects that the installation can access. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "installation": {
-    "id": 2,
-    "account": {
-      "login": "octocat",
-      "id": 1,
-      "node_id": "MDQ6VXNlcjE=",
-      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "https://api.github.com/installations/2/access_tokens",
-    "repositories_url": "https://api.github.com/installation/repositories",
-    "html_url": "https://github.com/settings/installations/2",
-    "app_id": 5725,
-    "target_id": 3880403,
-    "target_type": "User",
-    "permissions": {
-      "metadata": "read",
-      "contents": "read",
-      "issues": "write"
-    },
-    "events": [
-      "push",
-      "pull_request"
-    ],
-    "created_at": 1525109898,
-    "updated_at": 1525109899,
-    "single_file_name": "config.yml"
-  },
-  "repositories": [
-    {
-      "id": 1296269,
-      "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDc=",
-      "name": "Hello-World",
-      "full_name": "octocat/Hello-World",
-      "private": false
-    }
-  ],
-  "sender": {
-    "login": "octocat",
-    "id": 1,
-    "node_id": "MDQ6VXNlcjE=",
-    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - installation_repositories -

    -

    - Activity related to repositories being added to a GitHub App - installation. The type of activity is specified in the - action property of the payload object. For more - information, see the "GitHub App installation" REST API. -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be either added or - removed. -
    repository_selectionstring - The choice of repositories the installation is on. Can be either - selected or all. -
    repositories_addedarray - An array of repository objects, which were added to the - installation. -
    repositories_removedarray - An array of repository objects, which were removed from the - installation. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "installation": {
-    "id": 957387,
-    "account": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "https://api.github.com/app/installations/957387/access_tokens",
-    "repositories_url": "https://api.github.com/installation/repositories",
-    "html_url": "https://github.com/settings/installations/957387",
-    "app_id": 29310,
-    "target_id": 21031067,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "statuses": "write",
-      "repository_projects": "write",
-      "repository_hooks": "write",
-      "pull_requests": "write",
-      "pages": "write",
-      "issues": "write",
-      "deployments": "write",
-      "contents": "write",
-      "checks": "write",
-      "metadata": "read",
-      "vulnerability_alerts": "read"
-    },
-    "events": [],
-    "created_at": 1557933591,
-    "updated_at": 1557933591,
-    "single_file_name": null
-  },
-  "repository_selection": "selected",
-  "repositories_added": [
-    {
-      "id": 186853007,
-      "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDc=",
-      "name": "Space",
-      "full_name": "Codertocat/Space",
-      "private": false
-    }
-  ],
-  "repositories_removed": [],
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - issue_comment -

    -

    - Activity related to an issue or pull request comment. The type of - activity is specified in the action property of the payload - object. For more information, see the "issue comments" REST - API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Issues permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    issueobject - The issue the comment - belongs to. -
    commentobject - The - comment itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "issue": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://github.com/Codertocat/Hello-World/issues/1",
-    "id": 444500041,
-    "node_id": "MDU6SXNzdWU0NDQ1MDAwNDE=",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 1362934389,
-        "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5",
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://github.com/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 4317517,
-      "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T15:20:17Z",
-      "updated_at": "2019-05-15T15:20:18Z",
-      "due_on": "2019-05-23T07:00:00Z",
-      "closed_at": "2019-05-15T15:20:18Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T15:20:18Z",
-    "updated_at": "2019-05-15T15:20:21Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "comment": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments/492700400",
-    "html_url": "https://github.com/Codertocat/Hello-World/issues/1#issuecomment-492700400",
-    "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1",
-    "id": 492700400,
-    "node_id": "MDEyOklzc3VlQ29tbWVudDQ5MjcwMDQwMA==",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T15:20:21Z",
-    "updated_at": "2019-05-15T15:20:21Z",
-    "author_association": "OWNER",
-    "body": "You are totally right! I'll get this fixed right away."
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:13Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - issues -

    -

    - Activity related to an issue. The type of activity is specified in the - action property of the payload object. For more - information, see the "issues" - REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Issues permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of opened, - edited, deleted, pinned, - unpinned, closed, reopened, - assigned, unassigned, - labeled, unlabeled, locked, - unlocked, transferred, - milestoned, or demilestoned. -
    issueobjectThe issue itself.
    changesobject - The changes to the issue if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    assigneeobject - The optional user who was assigned or unassigned from the issue. -
    labelobject - The optional label that was added or removed from the issue. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example when someone edits an issue -

    -
    - 
    {
-  "action": "edited",
-  "issue": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://github.com/Codertocat/Hello-World/issues/1",
-    "id": 444500041,
-    "node_id": "MDU6SXNzdWU0NDQ1MDAwNDE=",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 1362934389,
-        "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5",
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://github.com/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 4317517,
-      "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T15:20:17Z",
-      "updated_at": "2019-05-15T15:20:18Z",
-      "due_on": "2019-05-23T07:00:00Z",
-      "closed_at": "2019-05-15T15:20:18Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T15:20:18Z",
-    "updated_at": "2019-05-15T15:20:18Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "changes": {},
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:13Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - label -

    -

    - Activity related to a label. The type of activity is specified in the - action property of the payload object. For more - information, see the "labels" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Metadata permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be created, - edited, or deleted. -
    labelobjectThe label that was added.
    changesobject - The changes to the label if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[color][from]string - The previous version of the color if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "label": {
-    "id": 1362937026,
-    "node_id": "MDU6TGFiZWwxMzYyOTM3MDI2",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix",
-    "name": ":bug: Bugfix",
-    "color": "cceeaa",
-    "default": false
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - marketplace_purchase -

    -

    - Activity related to a GitHub Marketplace purchase. The type of activity - is specified in the action property of the payload object. - For more information, see the "GitHub Marketplace." -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed for a - GitHub Marketplace - plan. Can be one of: -
      -
    • - purchased - Someone purchased a GitHub - Marketplace plan. The change should take effect on the account - immediately. -
      • -
    • - pending_change - You will receive the - pending_change event when someone has downgraded - or cancelled a GitHub Marketplace plan to indicate a change - will occur on the account. The new plan or cancellation takes - effect at the end of the billing cycle. The - cancelled or changed event type will - be sent when the billing cycle has ended and the cancellation - or new plan should take effect. -
      • -
    • - pending_change_cancelled - Someone has cancelled - a pending change. Pending changes include plan cancellations - and downgrades that will take effect at the end of a billing - cycle. -
      • -
    • - changed - Someone has upgraded or downgraded a - GitHub Marketplace plan and the change should take effect on - the account immediately. -
      • -
    • - cancelled - Someone cancelled a GitHub - Marketplace plan and the last billing cycle has ended. The - change should take effect on the account immediately. -
      • -
    -
    -

    - For a detailed description of this payload and the payload for each type - of action, see - GitHub - Marketplace webhook events. -

    -

    - - - - Webhook payload example when someone purchases the plan -

    -
    - 
    {
-  "action": "purchased",
-  "effective_date": "2017-10-25T00:00:00+00:00",
-  "sender": {
-    "login": "username",
-    "id": 3877742,
-    "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/username",
-    "html_url": "https://github.com/username",
-    "followers_url": "https://api.github.com/users/username/followers",
-    "following_url": "https://api.github.com/users/username/following{/other_user}",
-    "gists_url": "https://api.github.com/users/username/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/username/subscriptions",
-    "organizations_url": "https://api.github.com/users/username/orgs",
-    "repos_url": "https://api.github.com/users/username/repos",
-    "events_url": "https://api.github.com/users/username/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/username/received_events",
-    "type": "User",
-    "site_admin": true,
-    "email": "username@email.com"
-  },
-  "marketplace_purchase": {
-    "account": {
-      "type": "Organization",
-      "id": 18404719,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
-      "login": "username",
-      "organization_billing_email": "username@email.com"
-    },
-    "billing_cycle": "monthly",
-    "unit_count": 1,
-    "on_free_trial": false,
-    "free_trial_ends_on": null,
-    "next_billing_date": "2017-11-05T00:00:00+00:00",
-    "plan": {
-      "id": 435,
-      "name": "Basic Plan",
-      "description": "Basic Plan",
-      "monthly_price_in_cents": 1000,
-      "yearly_price_in_cents": 10000,
-      "price_model": "PER_UNIT",
-      "has_free_trial": true,
-      "unit_name": "seat",
-      "bullets": [
-        "Is Basic",
-        "Because Basic "
-      ]
-    }
-  }
-}
-
    -
    -

    - - - - member -

    -

    - Activity related to repository collaborators. The type of activity is - specified in the action property of the payload object. For - more information, see the "collaborators" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Members permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - added - A user accepts an invitation to a - repository. -
      • -
    • - removed - A user is removed as a collaborator in - a repository. -
      • -
    • - edited - A user's collaborator permissions have - changed. -
      • -
    -
    memberobject - The user that was added. -
    changesobject - The changes to the collaborator permissions if the action was - edited. -
    changes[old_permission][from]string - The previous permissions of the collaborator if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "member": {
-    "login": "hacktocat",
-    "id": 39652351,
-    "node_id": "MDQ6VXNlcjM5NjUyMzUx",
-    "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/hacktocat",
-    "html_url": "https://github.com/hacktocat",
-    "followers_url": "https://api.github.com/users/hacktocat/followers",
-    "following_url": "https://api.github.com/users/hacktocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/hacktocat/orgs",
-    "repos_url": "https://api.github.com/users/hacktocat/repos",
-    "events_url": "https://api.github.com/users/hacktocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "hacktocat",
-    "id": 39652351,
-    "node_id": "MDQ6VXNlcjM5NjUyMzUx",
-    "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/hacktocat",
-    "html_url": "https://github.com/hacktocat",
-    "followers_url": "https://api.github.com/users/hacktocat/followers",
-    "following_url": "https://api.github.com/users/hacktocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/hacktocat/orgs",
-    "repos_url": "https://api.github.com/users/hacktocat/repos",
-    "events_url": "https://api.github.com/users/hacktocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - membership -

    -

    - Activity related to team membership. The type of activity is specified - in the action property of the payload object. For more - information, see the "team members" REST API. -

    -

    - - - - Availability -

    -
      -
    • Organization webhooks
      • -
    • GitHub Apps with Members permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be added or - removed. -
    scopestring - The scope of the membership. Currently, can only be - team. -
    memberobject - The user that was added or - removed. -
    teamobject - The team for the - membership. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "removed",
-  "scope": "team",
-  "member": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "team": {
-    "name": "github",
-    "id": 3253328,
-    "node_id": "MDQ6VGVhbTMyNTMzMjg=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://api.github.com/teams/3253328",
-    "html_url": "https://github.com/orgs/Octocoders/teams/github",
-    "members_url": "https://api.github.com/teams/3253328/members{/member}",
-    "repositories_url": "https://api.github.com/teams/3253328/repos",
-    "permission": "pull"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "description": ""
-  }
-}
-
    -
    -

    - - - - merge_group -

    -
    -

    - Note: The pull request merge queue feature is - currently in limited public beta and subject to change. -

    -
    -

    - Activity related to merge groups in a merge queue. The type of activity - is specified in the action property of the payload object. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Merge queues permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - checks_requested. -
    merge_groupobjectThe merge group.
    merge_group[head_sha]stringThe SHA of the merge group.
    merge_group[head_ref]stringThe full ref of the merge group.
    merge_group[base_sha]stringThe SHA of the merge group's parent commit.
    merge_group[base_ref]string - The full ref of the branch the merge group will be merged into. -
    merge_group[head_commit]object - An expanded representation of the head_sha commit. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "checks_requested",
-  "merge_group": {
-    "head_sha": "2ffea6db159f6b6c47a24e778fb9ef40cf6b1c7d",
-    "head_ref": "refs/heads/gh-readonly-queue/main/pr-104-929f8209d40f77f4abc622a499c93a83babdbe64",
-    "base_sha": "380387fbc80638b734a49e1be1c4dfec1c01b33c",
-    "base_ref": "refs/heads/main",
-    "head_commit": {
-      "id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
-      "message": "Merge pull request #2048 from octo-repo/update-readme\n\nUpdate README.md",
-      "timestamp": "2019-05-15T15:20:30Z",
-      "author": {
-        "name": "Codertocat",
-        "email": "21031067+Codertocat@users.noreply.github.com"
-      },
-      "committer": {
-        "name": "Codertocat",
-        "email": "21031067+Codertocat@users.noreply.github.com"
-      }
-    }
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 1,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI="
-  }
-}
-
    -
    -

    - - - - meta -

    -

    - The webhook this event is configured on was deleted. This event will - only listen for changes to the particular hook the event is installed - on. Therefore, it must be selected for each hook that you'd like to - receive meta events for. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be deleted.
    hook_idintegerThe id of the modified webhook.
    hookobject - The modified webhook. This will contain different keys based on - the type of webhook it is: repository, organization, business, - app, or GitHub Marketplace. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "hook_id": 101047067,
-  "hook": {
-    "type": "Repository",
-    "id": 101047067,
-    "name": "web",
-    "active": true,
-    "events": [
-      "meta"
-    ],
-    "config": {
-      "content_type": "json",
-      "insecure_ssl": "0",
-      "url": "http://example.com/hook"
-    },
-    "updated_at": "2019-04-10T03:57:12Z",
-    "created_at": "2019-04-10T03:57:12Z"
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - milestone -

    -

    - Activity related to milestones. The type of activity is specified in the - action property of the payload object. For more - information, see the "milestones" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Pull requests permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - closed, opened (a closed milestone is - re-opened), edited, or deleted. -
    milestoneobjectThe milestone itself.
    changesobject - The changes to the milestone if the action was - edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[due_on][from]string - The previous version of the due date if the action was - edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "milestone": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1",
-    "html_url": "https://github.com/Codertocat/Hello-World/milestone/1",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels",
-    "id": 4317517,
-    "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==",
-    "number": 1,
-    "title": "v1.0",
-    "description": "Add new space flight simulator",
-    "creator": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "open_issues": 0,
-    "closed_issues": 0,
-    "state": "open",
-    "created_at": "2019-05-15T15:20:17Z",
-    "updated_at": "2019-05-15T15:20:17Z",
-    "due_on": "2019-05-23T07:00:00Z",
-    "closed_at": null
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:13Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - organization -

    -

    - Activity related to an organization and its members. The type of - activity is specified in the action property of the payload - object. For more information, see the "organizations" REST API. -

    -

    - - - - Availability -

    -
      -
    • - Organization webhooks only receive the deleted, - added, removed, renamed, and - invited events -
      • -
    • GitHub Apps with Members permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: - deleted, renamed, - member_added, member_removed, or - member_invited. -
    invitationobject - The invitation for the user or email if the action is - member_invited. -
    membershipobject - The membership between the user and the organization. Not present - when the action is member_invited. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "member_added",
-  "membership": {
-    "url": "https://api.github.com/orgs/Octocoders/memberships/hacktocat",
-    "state": "pending",
-    "role": "member",
-    "organization_url": "https://api.github.com/orgs/Octocoders",
-    "user": {
-      "login": "hacktocat",
-      "id": 39652351,
-      "node_id": "MDQ6VXNlcjM5NjUyMzUx",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/hacktocat",
-      "html_url": "https://github.com/hacktocat",
-      "followers_url": "https://api.github.com/users/hacktocat/followers",
-      "following_url": "https://api.github.com/users/hacktocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/hacktocat/orgs",
-      "repos_url": "https://api.github.com/users/hacktocat/repos",
-      "events_url": "https://api.github.com/users/hacktocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/hacktocat/received_events",
-      "type": "User",
-      "site_admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - org_block -

    -

    - Activity related to people being blocked in an organization. The type of - activity is specified in the action property of the payload - object. For more information, see the "blocking organization - users" REST API. -

    -

    - - - - Availability -

    -
      -
    • Organization webhooks
      • -
    • - GitHub Apps with Administration organization - permission -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be blocked or - unblocked. -
    blocked_userobjectInformation about the user that was blocked or unblocked.
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "blocked",
-  "blocked_user": {
-    "login": "hacktocat",
-    "id": 39652351,
-    "node_id": "MDQ6VXNlcjM5NjUyMzUx",
-    "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/hacktocat",
-    "html_url": "https://github.com/hacktocat",
-    "followers_url": "https://api.github.com/users/hacktocat/followers",
-    "following_url": "https://api.github.com/users/hacktocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/hacktocat/orgs",
-    "repos_url": "https://api.github.com/users/hacktocat/repos",
-    "events_url": "https://api.github.com/users/hacktocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Octocoders",
-    "html_url": "https://github.com/Octocoders",
-    "followers_url": "https://api.github.com/users/Octocoders/followers",
-    "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-    "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-    "repos_url": "https://api.github.com/users/Octocoders/repos",
-    "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - package -

    -

    - Activity related to GitHub Packages. The type of activity is specified - in the action property of the payload object. For more - information, see "Managing packages with GitHub - Packages" to learn more about GitHub Packages. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be published or - updated. -
    packageobjectInformation about the package.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "package": {
-    "id": 10696,
-    "name": "hello-world-npm",
-    "namespace": "Codertocat/hello-world-npm",
-    "description": null,
-    "ecosystem": "docker",
-    "package_type": "npm",
-    "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696",
-    "created_at": "2019-05-09T23:28:29Z",
-    "updated_at": "2019-05-09T23:28:29Z",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "package_version": {
-      "id": 24147,
-      "version": "1.0.0",
-      "summary": "A simple npm package to demonstrate GitHub Packages",
-      "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498",
-      "description": "",
-      "body": "# hello-world-npm\n\nThis is a simple npm package that demonstrates the [Github Packages](https://github.com/features/package).\n\n## Installation \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n",
-      "body_html": "<h1>hello-world-npm</h1>\n<p>This is a simple npm package that demonstrates the <a href=\"https://github.com/features/package\">Github Package Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ npm install</code></p>\n<h2>Usage</h2>\n<pre><code>const myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>",
-      "release": {
-        "url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286",
-        "html_url": "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0",
-        "id": 17264286,
-        "tag_name": "1.0.0",
-        "target_commitish": "master",
-        "name": "1.0.0",
-        "draft": false,
-        "author": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "prerelease": false,
-        "created_at": "2019-05-09T23:24:40Z",
-        "published_at": "2019-05-09T23:26:59Z"
-      },
-      "manifest": "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A simple npm package to demonstrate GitHub Package Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo \\\"Error: no test specified\\\" \\u0026\\u0026 exit 1\"},\"version\":\"1.0.0\"}",
-      "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0",
-      "tag_name": "1.0.0",
-      "target_commitish": "master",
-      "target_oid": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b",
-      "draft": false,
-      "prerelease": false,
-      "created_at": "2019-05-09T23:28:29Z",
-      "updated_at": "2019-05-09T23:28:30Z",
-      "metadata": [],
-      "docker_metadata": [],
-      "package_files": [
-        {
-          "download_url": "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream",
-          "id": 92167,
-          "name": "hello-world-npm-1.0.0-npm.tgz",
-          "sha256": "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8",
-          "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb",
-          "md5": "56ebbd5a5a03367f62d0c732bafd3c66",
-          "content_type": "application/octet-stream",
-          "state": "uploaded",
-          "size": 654,
-          "created_at": "2019-05-09T23:28:30Z",
-          "updated_at": "2019-05-09T23:28:30Z"
-        }
-      ],
-      "author": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "source_url": "ghcr.io/Codertocat/hello-world-npm/image-1:v1",
-      "installation_command": "npm install @Codertocat/@1.0.0"
-    },
-    "registry": {
-      "about_url": "https://help.github.com/about-github-packages",
-      "name": "GitHub npm registry",
-      "type": "npm",
-      "url": "https://npm.pkg.github.com/@Codertocat",
-      "vendor": "GitHub Inc"
-    }
-  },
-  "repository": {
-    "id": 185882436,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=",
-    "name": "hello-world-npm",
-    "full_name": "Codertocat/hello-world-npm",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/hello-world-npm",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world-npm",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments",
-    "created_at": "2019-05-09T22:53:26Z",
-    "updated_at": "2019-05-09T23:24:42Z",
-    "pushed_at": "2019-05-09T23:27:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world-npm.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world-npm.git",
-    "clone_url": "https://github.com/Codertocat/hello-world-npm.git",
-    "svn_url": "https://github.com/Codertocat/hello-world-npm",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - page_build -

    -

    - Represents an attempted build of a GitHub Pages site, whether successful - or not. A push to a GitHub Pages enabled branch (gh-pages - for project pages, the default branch for user and organization pages) - triggers this event. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Pages permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    idintegerThe unique identifier of the page build.
    buildobject - The - List GitHub Pages builds - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "id": 130514899,
-  "build": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/pages/builds/130514899",
-    "status": "built",
-    "error": {
-      "message": null
-    },
-    "pusher": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "commit": "507fc9acd0d04ac4a9db87d12cb228c052cd813a",
-    "duration": 16984,
-    "created_at": "2019-05-15T15:20:23Z",
-    "updated_at": "2019-05-15T15:20:40Z"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:34Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - ping -

    -

    - When you create a new webhook, we'll send you a simple - ping event to let you know you've set up the webhook - correctly. This event isn't stored so it isn't retrievable via the - Events API - endpoint. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps receive a ping event with an app_id used to - register the app -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    zenstringRandom string of GitHub zen.
    hook_idintegerThe ID of the webhook that triggered the ping.
    hookobject - The - webhook configuration. -
    hook[app_id]integer - When you register a new GitHub App, GitHub sends a ping event to - the webhook URL you specified during - registration. The event contains the app_id, which is - required for - authenticating - an app. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "zen": "Anything added dilutes everything else.",
-  "hook_id": 109948940,
-  "hook": {
-    "type": "Repository",
-    "id": 109948940,
-    "name": "web",
-    "active": true,
-    "events": [
-      "*"
-    ],
-    "config": {
-      "content_type": "json",
-      "url": "https://smee.io/****************",
-      "insecure_ssl": "0"
-    },
-    "updated_at": "2019-05-15T15:20:49Z",
-    "created_at": "2019-05-15T15:20:49Z",
-    "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940",
-    "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test",
-    "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings",
-    "last_response": {
-      "code": null,
-      "status": "unused",
-      "message": null
-    }
-  },
-  "repository": {
-    "id": 186853261,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 38302899,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Octocoders",
-      "html_url": "https://github.com/Octocoders",
-      "followers_url": "https://api.github.com/users/Octocoders/followers",
-      "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-      "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-      "repos_url": "https://api.github.com/users/Octocoders/repos",
-      "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://api.github.com/repos/Octocoders/Hello-World",
-    "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T15:20:42Z",
-    "updated_at": "2019-05-15T15:20:45Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Octocoders/Hello-World.git",
-    "ssh_url": "git@github.com:Octocoders/Hello-World.git",
-    "clone_url": "https://github.com/Octocoders/Hello-World.git",
-    "svn_url": "https://github.com/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - project -

    -

    - Activity related to classic projects. The type of activity is specified - in the action property of the payload object. For more - information, see the "projects" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Projects repository or organization - permission -
      • -
    -
    -

    - Note: This event only occurs for projects (classic). -

    -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project. Can be one of - created, edited, closed, - reopened, or deleted. -
    changesobject - The changes to the project if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    projectobject - The project itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project": {
-    "owner_url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "url": "https://api.github.com/projects/2640902",
-    "html_url": "https://github.com/Codertocat/Hello-World/projects/1",
-    "columns_url": "https://api.github.com/projects/2640902/columns",
-    "id": 2640902,
-    "node_id": "MDc6UHJvamVjdDI2NDA5MDI=",
-    "name": "Space 2.0",
-    "body": "Project tasks for a trip to Space",
-    "number": 1,
-    "state": "open",
-    "creator": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T15:21:06Z",
-    "updated_at": "2019-05-15T15:21:06Z"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - project_card -

    -

    - Activity related to cards in a classic project. The type of activity is - specified in the action property of the payload object. For - more information, see the "project cards" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Projects repository or organization - permission -
      • -
    -
    -

    - Note: This event only occurs for projects (classic). -

    -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed on the project card. Can be - created, edited, moved, - converted, or deleted. -
    changesobject - The changes to the project card if the action was - edited or converted. -
    changes[note][from]string - The previous version of the note if the action was - edited or converted. -
    after_idinteger - The id of the card that this card now follows if the action was - "moved". Will be null if it is the first card in a - column. -
    project_cardobject - The - project card - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_card": {
-    "url": "https://api.github.com/projects/columns/cards/21567453",
-    "project_url": "https://api.github.com/projects/2640902",
-    "column_url": "https://api.github.com/projects/columns/5368157",
-    "column_id": 5368157,
-    "id": 21567453,
-    "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=",
-    "note": "Work that can be completed in one hour or less.",
-    "archived": false,
-    "creator": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T15:21:10Z",
-    "updated_at": "2019-05-15T15:21:10Z"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - project_column -

    -

    - Activity related to columns in a classic project. The type of activity - is specified in the action property of the payload object. - For more information, see the "project columns" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Projects repository or organization - permission -
      • -
    -
    -

    - Note: This event only occurs for projects (classic). -

    -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project column. Can be one of - created, edited, moved or - deleted. -
    changesobject - The changes to the project column if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    after_idinteger - The id of the column that this column now follows if the action - was "moved". Will be null if it is the first column - in a project. -
    project_columnobject - The - project column - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_column": {
-    "url": "https://api.github.com/projects/columns/5368157",
-    "project_url": "https://api.github.com/projects/2640902",
-    "cards_url": "https://api.github.com/projects/columns/5368157/cards",
-    "id": 5368157,
-    "node_id": "MDEzOlByb2plY3RDb2x1bW41MzY4MTU3",
-    "name": "Small bugfixes",
-    "created_at": "2019-05-15T15:21:09Z",
-    "updated_at": "2019-05-15T15:21:09Z"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - projects_v2_item -

    -
    -

    - Note: Webhook events for projects are currently in - beta and subject to change. To share feedback about projects webhooks - with GitHub, see the - Projects webhook feedback discussion. -

    -
    -

    - Activity related to items in a project. The type of activity is - specified in the action property of the payload object. For - more information, see "About - projects." -

    -

    - - - - Availability -

    -
      -
    • Organization webhooks
      • -
    • - GitHub Apps with Projects organization permission -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project item. Can be one of - archived, converted, - created, edited, restored, - deleted, or reordered. -
    projects_v2_itemobject - The project item itself. To find more information about the - project item, you can use node_id (the node ID of the - project item) and project_node_id (the node ID of the - project) to query information in the GraphQL API. For more - information, see "Using - the API to manage projects." -
    changesobjectThe changes to the project item.
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "projects_v2_item": {
-    "id": 15,
-    "node_id": "PVTI_lAAEAQ8",
-    "project_node_id": "PVT_kwAEAQ",
-    "content_node_id": "DI_lAAEAQo",
-    "content_type": "DraftIssue",
-    "creator": {
-      "login": "monalisa",
-      "id": 2,
-      "node_id": "U_kgAC",
-      "avatar_url": "http://alambic.github.com/avatars/u/2?",
-      "gravatar_id": "",
-      "url": "http://api.github.com/users/monalisa",
-      "html_url": "http://github.com/monalisa",
-      "followers_url": "http://api.github.com/users/monalisa/followers",
-      "following_url": "http://api.github.com/users/monalisa/following{/other_user}",
-      "gists_url": "http://api.github.com/users/monalisa/gists{/gist_id}",
-      "starred_url": "http://api.github.com/users/monalisa/starred{/owner}{/repo}",
-      "subscriptions_url": "http://api.github.com/users/monalisa/subscriptions",
-      "organizations_url": "http://api.github.com/users/monalisa/orgs",
-      "repos_url": "http://api.github.com/users/monalisa/repos",
-      "events_url": "http://api.github.com/users/monalisa/events{/privacy}",
-      "received_events_url": "http://api.github.com/users/monalisa/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "created_at": "2022-05-20T21:20:57Z",
-    "updated_at": "2022-05-20T21:20:57Z",
-    "archived_at": null
-  },
-  "organization": {
-    "login": "github",
-    "id": 4,
-    "node_id": "O_kgAE",
-    "url": "http://api.github.com/orgs/github",
-    "repos_url": "http://api.github.com/orgs/github/repos",
-    "events_url": "http://api.github.com/orgs/github/events",
-    "hooks_url": "http://api.github.com/orgs/github/hooks",
-    "issues_url": "http://api.github.com/orgs/github/issues",
-    "members_url": "http://api.github.com/orgs/github/members{/member}",
-    "public_members_url": "http://api.github.com/orgs/github/public_members{/member}",
-    "avatar_url": "http://alambic.github.com/avatars/u/4?",
-    "description": null
-  },
-  "sender": {
-    "login": "monalisa",
-    "id": 2,
-    "node_id": "U_kgAC",
-    "avatar_url": "http://alambic.github.com/avatars/u/2?",
-    "gravatar_id": "",
-    "url": "http://api.github.com/users/monalisa",
-    "html_url": "http://github.com/monalisa",
-    "followers_url": "http://api.github.com/users/monalisa/followers",
-    "following_url": "http://api.github.com/users/monalisa/following{/other_user}",
-    "gists_url": "http://api.github.com/users/monalisa/gists{/gist_id}",
-    "starred_url": "http://api.github.com/users/monalisa/starred{/owner}{/repo}",
-    "subscriptions_url": "http://api.github.com/users/monalisa/subscriptions",
-    "organizations_url": "http://api.github.com/users/monalisa/orgs",
-    "repos_url": "http://api.github.com/users/monalisa/repos",
-    "events_url": "http://api.github.com/users/monalisa/events{/privacy}",
-    "received_events_url": "http://api.github.com/users/monalisa/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - - - public -

    -

    - When a private repository is made public. Without a doubt: the best - GitHub event. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Metadata permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - pull_request -

    -

    - Activity related to pull requests. The type of activity is specified in - the action property of the payload object. For more - information, see the "pull requests" REST API. -

    -
    -

    - Note: The pull request merge queue feature is - currently in limited public beta and subject to change. -

    -
    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Pull requests permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • assigned
      • -
    • auto_merge_disabled
      • -
    • auto_merge_enabled
      • -
    • - closed: If the action is closed and - the merged key is false, the pull - request was closed with unmerged commits. If the action is - closed and the merged key is - true, the pull request was merged. -
      • -
    • converted_to_draft
      • -
    • - dequeued: Triggered when a pull request is - removed from a merge queue -
      • -
    • edited
      • -
    • - enqueued: Triggered when a pull request is added - to a merge queue -
      • -
    • labeled
      • -
    • locked
      • -
    • opened
      • -
    • ready_for_review
      • -
    • reopened
      • -
    • review_request_removed
      • -
    • review_requested
      • -
    • - synchronize: Triggered when a pull request's head - branch is updated. For example, when the head branch is - updated from the base branch, when new commits are pushed to - the head branch, or when the base branch is changed. -
      • -
    • unassigned
      • -
    • unlabeled
      • -
    • unlocked
      • -
    -
    numberintegerThe pull request number.
    changesobject - The changes to the comment if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The pull request itself. -
    reasonstring - The reason the pull request was removed from a merge queue if the - action was dequeued. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -

    - Deliveries for review_requested and - review_request_removed events will have an additional field - called requested_reviewer. -

    -
    - 
    {
-  "action": "opened",
-  "number": 2,
-  "pull_request": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-    "id": 279147437,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3",
-    "html_url": "https://github.com/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T15:20:33Z",
-    "updated_at": "2019-05-15T15:20:33Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": null,
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "user": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 186853002,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://api.github.com/repos/Codertocat/Hello-World",
-        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T15:19:25Z",
-        "updated_at": "2019-05-15T15:19:27Z",
-        "pushed_at": "2019-05-15T15:20:32Z",
-        "git_url": "git://github.com/Codertocat/Hello-World.git",
-        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-        "clone_url": "https://github.com/Codertocat/Hello-World.git",
-        "svn_url": "https://github.com/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master",
-        "allow_squash_merge": true,
-        "allow_merge_commit": true,
-        "allow_rebase_merge": true,
-        "delete_branch_on_merge": false
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-      "user": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 186853002,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://api.github.com/repos/Codertocat/Hello-World",
-        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T15:19:25Z",
-        "updated_at": "2019-05-15T15:19:27Z",
-        "pushed_at": "2019-05-15T15:20:32Z",
-        "git_url": "git://github.com/Codertocat/Hello-World.git",
-        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-        "clone_url": "https://github.com/Codertocat/Hello-World.git",
-        "svn_url": "https://github.com/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master",
-        "allow_squash_merge": true,
-        "allow_merge_commit": true,
-        "allow_rebase_merge": true,
-        "delete_branch_on_merge": false
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://github.com/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
-      }
-    },
-    "author_association": "OWNER",
-    "draft": false,
-    "merged": false,
-    "mergeable": null,
-    "rebaseable": null,
-    "mergeable_state": "unknown",
-    "merged_by": null,
-    "comments": 0,
-    "review_comments": 0,
-    "maintainer_can_modify": false,
-    "commits": 1,
-    "additions": 1,
-    "deletions": 1,
-    "changed_files": 1
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - pull_request_review -

    -

    - Activity related to pull request reviews. The type of activity is - specified in the action property of the payload object. For - more information, see the "pull request reviews" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Pull requests permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - submitted - A pull request review is submitted - into a non-pending state. -
      • -
    • - edited - The body of a review has been edited. -
      • -
    • dismissed - A review has been dismissed.
      • -
    -
    pull_requestobject - The pull request the review - pertains to. -
    reviewobjectThe review that was affected.
    changes[body][from]string - The previous version of the body if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "submitted",
-  "review": {
-    "id": 237895671,
-    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": null,
-    "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "submitted_at": "2019-05-15T15:20:38Z",
-    "state": "commented",
-    "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671",
-    "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "html": {
-        "href": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671"
-      },
-      "pull_request": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-    "id": 279147437,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3",
-    "html_url": "https://github.com/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T15:20:33Z",
-    "updated_at": "2019-05-15T15:20:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "user": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 186853002,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://api.github.com/repos/Codertocat/Hello-World",
-        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T15:19:25Z",
-        "updated_at": "2019-05-15T15:20:34Z",
-        "pushed_at": "2019-05-15T15:20:33Z",
-        "git_url": "git://github.com/Codertocat/Hello-World.git",
-        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-        "clone_url": "https://github.com/Codertocat/Hello-World.git",
-        "svn_url": "https://github.com/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master",
-        "allow_squash_merge": true,
-        "allow_merge_commit": true,
-        "allow_rebase_merge": true,
-        "delete_branch_on_merge": false
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-      "user": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 186853002,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://api.github.com/repos/Codertocat/Hello-World",
-        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T15:19:25Z",
-        "updated_at": "2019-05-15T15:20:34Z",
-        "pushed_at": "2019-05-15T15:20:33Z",
-        "git_url": "git://github.com/Codertocat/Hello-World.git",
-        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-        "clone_url": "https://github.com/Codertocat/Hello-World.git",
-        "svn_url": "https://github.com/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master",
-        "allow_squash_merge": true,
-        "allow_merge_commit": true,
-        "allow_rebase_merge": true,
-        "delete_branch_on_merge": false
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://github.com/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:34Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - pull_request_review_comment -

    -

    - Activity related to pull request review comments in the pull request's - unified diff. The type of activity is specified in the - action property of the payload object. For more - information, see the "pull request review comments" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Pull requests permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The pull request the - comment belongs to. -
    commentobject - The - comment itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630",
-    "pull_request_review_id": 237895671,
-    "id": 284312630,
-    "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==",
-    "diff_hunk": "@@ -1 +1 @@\n-# Hello-World",
-    "path": "README.md",
-    "position": 1,
-    "original_position": 1,
-    "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "Maybe you should use more emoji on this line.",
-    "created_at": "2019-05-15T15:20:37Z",
-    "updated_at": "2019-05-15T15:20:38Z",
-    "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630",
-    "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630"
-      },
-      "html": {
-        "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630"
-      },
-      "pull_request": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
-    "id": 279147437,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3",
-    "html_url": "https://github.com/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T15:20:33Z",
-    "updated_at": "2019-05-15T15:20:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-      "user": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 186853002,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://api.github.com/repos/Codertocat/Hello-World",
-        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T15:19:25Z",
-        "updated_at": "2019-05-15T15:20:34Z",
-        "pushed_at": "2019-05-15T15:20:33Z",
-        "git_url": "git://github.com/Codertocat/Hello-World.git",
-        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-        "clone_url": "https://github.com/Codertocat/Hello-World.git",
-        "svn_url": "https://github.com/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master",
-        "allow_squash_merge": true,
-        "allow_merge_commit": true,
-        "allow_rebase_merge": true,
-        "delete_branch_on_merge": false
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-      "user": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 186853002,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://api.github.com/repos/Codertocat/Hello-World",
-        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T15:19:25Z",
-        "updated_at": "2019-05-15T15:20:34Z",
-        "pushed_at": "2019-05-15T15:20:33Z",
-        "git_url": "git://github.com/Codertocat/Hello-World.git",
-        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-        "clone_url": "https://github.com/Codertocat/Hello-World.git",
-        "svn_url": "https://github.com/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master",
-        "allow_squash_merge": true,
-        "allow_merge_commit": true,
-        "allow_rebase_merge": true,
-        "delete_branch_on_merge": false
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://github.com/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:34Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - pull_request_review_thread -

    -

    - Activity related to a comment thread on a pull request being marked as - resolved or unresolved. The type of activity is specified in the - action property of the payload object. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Pull requests permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - resolved - A comment thread on a pull request was - marked as resolved. -
      • -
    • - unresolved - A previously resolved comment thread - on a pull request was marked as unresolved. -
      • -
    -
    pull_requestobject - The pull request the thread - pertains to. -
    threadobjectThe thread that was affected.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "resolved",
-  "pull_request": {
-    "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-    "id": 873298238,
-    "node_id": "PR_kwDOEL39TM40DXk-",
-    "html_url": "https://github.com/octo-org/octo-repo/pull/118",
-    "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff",
-    "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch",
-    "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118",
-    "number": 118,
-    "state": "open",
-    "locked": false,
-    "title": "Create issue-comment",
-    "user": {
-      "login": "octocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "body": "Issue comment test",
-    "created_at": "2022-03-07T16:14:34Z",
-    "updated_at": "2022-03-21T09:21:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "draft": false,
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits",
-    "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments",
-    "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-    "head": {
-      "label": "octo-org:issue-comment",
-      "ref": "issue-comment",
-      "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "octo-org:master",
-      "ref": "master",
-      "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-      },
-      "html": {
-        "href": "https://github.com/octo-org/octo-repo/pull/118"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf"
-      }
-    },
-    "author_association": "CONTRIBUTOR",
-    "auto_merge": null,
-    "active_lock_reason": null
-  },
-  "thread": {
-    "node_id": "PRRT_kwDOEL39TM4w7XDQ",
-    "comments": [
-      {
-        "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280",
-        "pull_request_review_id": 901921390,
-        "id": 820867280,
-        "node_id": "PRRC_kwDOEL39TM4w7XDQ",
-        "diff_hunk": "@@ -0,0 +1 @@\n+issue comment",
-        "path": "issue-comment",
-        "position": 1,
-        "original_position": 1,
-        "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "user": {
-          "login": "jide2020",
-          "id": 64502150,
-          "node_id": "MDQ6VXNlcjY0NTAyMTUw",
-          "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/jide2020",
-          "html_url": "https://github.com/jide2020",
-          "followers_url": "https://api.github.com/users/jide2020/followers",
-          "following_url": "https://api.github.com/users/jide2020/following{/other_user}",
-          "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions",
-          "organizations_url": "https://api.github.com/users/jide2020/orgs",
-          "repos_url": "https://api.github.com/users/jide2020/repos",
-          "events_url": "https://api.github.com/users/jide2020/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/jide2020/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "body": "sup",
-        "created_at": "2022-03-07T16:16:48Z",
-        "updated_at": "2022-03-07T16:16:58Z",
-        "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280",
-        "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-        "author_association": "COLLABORATOR",
-        "_links": {
-          "self": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280"
-          },
-          "html": {
-            "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280"
-          },
-          "pull_request": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-          }
-        },
-        "reactions": {
-          "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions",
-          "total_count": 0,
-          "+1": 0,
-          "-1": 0,
-          "laugh": 0,
-          "hooray": 0,
-          "confused": 0,
-          "heart": 0,
-          "rocket": 0,
-          "eyes": 0
-        },
-        "start_line": null,
-        "original_start_line": null,
-        "start_side": null,
-        "line": 1,
-        "original_line": 1,
-        "side": "RIGHT"
-      }
-    ]
-  },
-  "repository": {
-    "id": 280886604,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 67584941,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-      "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "Change description",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2020-07-19T14:48:35Z",
-    "updated_at": "2022-03-11T11:56:22Z",
-    "pushed_at": "2022-04-01T09:37:36Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 646,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 60,
-    "license": null,
-    "allow_forking": false,
-    "is_template": false,
-    "topics": [
-      "hey",
-      "topic"
-    ],
-    "visibility": "private",
-    "forks": 0,
-    "open_issues": 60,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 67584941,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - - - push -

    -

    One or more commits are pushed to a repository branch or tag.

    -
    -

    - Note: You will not receive a webhook for this event - when you push more than three tags at once. -

    -
    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The full - git ref - that was pushed. Example: refs/heads/main or - refs/tags/v3.14.1. -
    beforestring - The SHA of the most recent commit on ref before the - push. -
    afterstring - The SHA of the most recent commit on ref after the - push. -
    createdbooleanWhether this push created the ref.
    deletedbooleanWhether this push deleted the ref.
    forcedbooleanWhether this push was a force push of the ref.
    head_commitobject - For pushes where after is or points to a commit - object, an expanded representation of that commit. For pushes - where after refers to an annotated tag object, an - expanded representation of the commit pointed to by the annotated - tag. -
    comparestring - 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. -
    commitsarray - 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.) -
    commits[][id]stringThe SHA of the commit.
    commits[][timestamp]stringThe ISO 8601 timestamp of the commit.
    commits[][message]stringThe commit message.
    commits[][author]objectThe git author of the commit.
    commits[][author][name]stringThe git author's name.
    commits[][author][email]stringThe git author's email address.
    commits[][url]urlURL that points to the commit API resource.
    commits[][distinct]boolean - Whether this commit is distinct from any that have been pushed - before. -
    commits[][added]array - An array of files added in the commit. For extremely large commits - where GitHub is unable to calculate this list in a timely manner, - this may be empty even if files were added. -
    commits[][modified]array - An array of files modified by the commit. For extremely large - commits where GitHub is unable to calculate this list in a timely - manner, this may be empty even if files were modified. -
    commits[][removed]array - An array of files removed in the commit. For extremely large - commits where GitHub is unable to calculate this list in a timely - manner, this may be empty even if files were removed. -
    pusherobjectThe user who pushed the commits.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "ref": "refs/tags/simple-tag",
-  "before": "0000000000000000000000000000000000000000",
-  "after": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-  "created": true,
-  "deleted": false,
-  "forced": false,
-  "base_ref": null,
-  "compare": "https://github.com/Codertocat/Hello-World/compare/simple-tag",
-  "commits": [],
-  "head_commit": {
-    "id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "tree_id": "4b825dc642cb6eb9a060e54bf8d69288fbee4904",
-    "distinct": true,
-    "message": "Adding a .gitignore file",
-    "timestamp": "2019-05-15T15:20:41Z",
-    "url": "https://github.com/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "author": {
-      "name": "Codertocat",
-      "email": "21031067+Codertocat@users.noreply.github.com",
-      "username": "Codertocat"
-    },
-    "committer": {
-      "name": "Codertocat",
-      "email": "21031067+Codertocat@users.noreply.github.com",
-      "username": "Codertocat"
-    },
-    "added": [
-      ".gitignore"
-    ],
-    "removed": [],
-    "modified": []
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "name": "Codertocat",
-      "email": "21031067+Codertocat@users.noreply.github.com",
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://github.com/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": 1557933565,
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": 1557933657,
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master",
-    "stargazers": 0,
-    "master_branch": "master"
-  },
-  "pusher": {
-    "name": "Codertocat",
-    "email": "21031067+Codertocat@users.noreply.github.com"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - release -

    -

    - Activity related to a release. The type of activity is specified in the - action property of the payload object. For more - information, see the "releases" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - published: a release, pre-release, or draft of a - release is published -
      • -
    • - unpublished: a release or pre-release is deleted -
      • -
    • - created: a draft is saved, or a release or - pre-release is published without previously being saved as a - draft -
      • -
    • - edited: a release, pre-release, or draft release - is edited -
      • -
    • - deleted: a release, pre-release, or draft release - is deleted -
      • -
    • prereleased: a pre-release is created
      • -
    • - released: a release is published, or a - pre-release is changed to a release -
      • -
    -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    releaseobject - The - release - object. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "release": {
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790",
-    "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets",
-    "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}",
-    "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1",
-    "id": 17372790,
-    "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw",
-    "tag_name": "0.0.1",
-    "target_commitish": "master",
-    "name": null,
-    "draft": false,
-    "author": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "prerelease": false,
-    "created_at": "2019-05-15T15:19:25Z",
-    "published_at": "2019-05-15T15:20:53Z",
-    "assets": [],
-    "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1",
-    "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1",
-    "body": null
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:52Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - repository_dispatch -

    -

    - This event occurs when a GitHub App sends a POST request to - the "Create a repository dispatch - event" endpoint. -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "on-demand-test",
-  "branch": "master",
-  "client_payload": {
-    "unit": false,
-    "integration": true
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2018-10-10T15:58:51Z",
-    "pushed_at": "2018-10-10T15:58:47Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 59,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 23,
-    "license": null,
-    "forks": 1,
-    "open_issues": 23,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 375706,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2"
-  }
-}
-
    -
    -

    - - - - repository -

    -

    - Activity related to a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "repositories" REST API. -

    -

    - - - - Availability -

    -
      -
    • - Repository webhooks receive all event types except - deleted -
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Metadata permission receive all - event types except deleted -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of: -
      -
    • created - A repository is created.
      • -
    • deleted - A repository is deleted.
      • -
    • archived - A repository is archived.
      • -
    • unarchived - A repository is unarchived.
      • -
    • - edited - A repository's information is edited. -
      • -
    • renamed - A repository is renamed.
      • -
    • transferred - A repository is transferred.
      • -
    • publicized - A repository is made public.
      • -
    • privatized - A repository is made private.
      • -
    -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "publicized",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:21:03Z",
-    "pushed_at": "2019-05-15T15:20:57Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - repository_import -

    -

    - Activity related to a repository being imported to GitHub. The type of - activity is specified in the action property of the payload - object. For more information, see the "source - imports" REST API. To receive this event for a personal repository, you must - create an empty repository prior to the import. This event can be - triggered using either the - GitHub Importer - or the - Source imports API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    statusstring - The final state of the import. This can be one of - success, cancelled, or - failure. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "status": "success",
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:49Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - repository_vulnerability_alert -

    -
    -

    - Deprecation note: The - repository_vulnerability_alert webhook events described - below are deprecated and are documented here for reference only. Use - dependabot_alert as an - alternative. -

    -
    -

    - Activity related to security vulnerability alerts in a repository. The - type of activity is specified in the action property of the - payload object. For more information, see the "About Dependabot - alerts". -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - create, dismiss, or - resolve. -
    alertobjectThe security alert of the vulnerable dependency.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "create",
-  "alert": {
-    "id": 91095730,
-    "affected_range": ">= 2.0.4, < 2.0.6",
-    "affected_package_name": "rack",
-    "fixed_in": "2.0.6",
-    "external_reference": "https://nvd.nist.gov/vuln/detail/CVE-2018-16470",
-    "external_identifier": "CVE-2018-16470",
-    "severity": "moderate",
-    "ghsa_id": "GHSA-hg78-4f6x-99wq",
-    "created_at": "2021-03-01T01:23:45Z"
-  },
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "github",
-    "id": 9919,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/9919?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/github",
-    "html_url": "https://github.com/github",
-    "followers_url": "https://api.github.com/users/github/followers",
-    "following_url": "https://api.github.com/users/github/following{/other_user}",
-    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
-    "organizations_url": "https://api.github.com/users/github/orgs",
-    "repos_url": "https://api.github.com/users/github/repos",
-    "events_url": "https://api.github.com/users/github/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/github/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - security_advisory -

    -

    - Activity related to a security advisory that has been reviewed by - GitHub. A GitHub-reviewed security advisory provides information about - security-related vulnerabilities in software on GitHub. -

    -

    - The security advisory dataset also powers the GitHub Dependabot alerts. - For more information, see "About Dependabot - alerts." -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. The action can be one of - published, updated, - performed, or withdrawn for all new - events. -
    security_advisoryobject - The details of the security advisory, including summary, - description, and severity. -
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "security_advisory": {
-    "ghsa_id": "GHSA-rf4j-j272-fj86",
-    "summary": "Moderate severity vulnerability that affects django",
-    "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
-    "severity": "moderate",
-    "identifiers": [
-      {
-        "value": "GHSA-rf4j-j272-fj86",
-        "type": "GHSA"
-      },
-      {
-        "value": "CVE-2018-6188",
-        "type": "CVE"
-      }
-    ],
-    "references": [
-      {
-        "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
-      }
-    ],
-    "published_at": "2018-10-03T21:13:54Z",
-    "updated_at": "2018-10-03T21:13:54Z",
-    "withdrawn_at": null,
-    "vulnerabilities": [
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
-        "first_patched_version": {
-          "identifier": "2.0.2"
-        }
-      },
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
-        "first_patched_version": {
-          "identifier": "1.11.10"
-        }
-      }
-    ]
-  }
-}
-
    -
    -

    - - - - sponsorship -

    -

    - Activity related to a sponsorship listing. The type of activity is - specified in the action property of the payload object. For - more information, see "About - GitHub Sponsors". -

    -

    - You can only create a sponsorship webhook on GitHub. For more - information, see "Configuring - webhooks for events in your sponsored account". -

    -

    - - - - Availability -

    -
      -
    • Sponsored accounts
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - created, cancelled, edited, - tier_changed, pending_cancellation, or - pending_tier_change. Note: The - created action is only triggered after payment is - processed. -
    effective_datestring - The pending_cancellation and - pending_tier_change event types will include the date - the cancellation or tier change will take effect. -
    changes[tier][from]object - 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. -
    changes[privacy_level][from]string - The edited event types include the details about the - change when someone edits a sponsorship to change the privacy. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example when someone creates a sponsorship -

    -
    - 
    {
-  "action": "created",
-  "sponsorship": {
-    "node_id": "MDExOlNwb25zb3JzaGlwMQ==",
-    "created_at": "2019-12-20T19:24:46+00:00",
-    "sponsorable": {
-      "login": "octocat",
-      "id": 5,
-      "node_id": "MDQ6VXNlcjU=",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/5?",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "sponsor": {
-      "login": "monalisa",
-      "id": 2,
-      "node_id": "MDQ6VXNlcjI=",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/monalisa",
-      "html_url": "https://github.com/monalisa",
-      "followers_url": "https://api.github.com/users/monalisa/followers",
-      "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
-      "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
-      "organizations_url": "https://api.github.com/users/monalisa/orgs",
-      "repos_url": "https://api.github.com/users/monalisa/repos",
-      "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/monalisa/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "privacy_level": "public",
-    "tier": {
-      "node_id": "MDEyOlNwb25zb3JzVGllcjE=",
-      "created_at": "2019-12-20T19:17:05Z",
-      "description": "foo",
-      "monthly_price_in_cents": 500,
-      "monthly_price_in_dollars": 5,
-      "name": "$5 a month",
-      "is_one_time": false,
-      "is_custom_amount": false
-    }
-  },
-  "sender": {
-    "login": "monalisa",
-    "id": 2,
-    "node_id": "MDQ6VXNlcjI=",
-    "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/monalisa",
-    "html_url": "https://github.com/monalisa",
-    "followers_url": "https://api.github.com/users/monalisa/followers",
-    "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
-    "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
-    "organizations_url": "https://api.github.com/users/monalisa/orgs",
-    "repos_url": "https://api.github.com/users/monalisa/repos",
-    "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/monalisa/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - - - Webhook payload example when someone downgrades a sponsorship -

    -
    - 
    {
-  "action": "pending_tier_change",
-  "sponsorship": {
-    "node_id": "MDExOlNwb25zb3JzaGlwMQ==",
-    "created_at": "2019-12-20T19:24:46+00:00",
-    "sponsorable": {
-      "login": "octocat",
-      "id": 5,
-      "node_id": "MDQ6VXNlcjU=",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/5?",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "sponsor": {
-      "login": "monalisa",
-      "id": 2,
-      "node_id": "MDQ6VXNlcjI=",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/monalisa",
-      "html_url": "https://github.com/monalisa",
-      "followers_url": "https://api.github.com/users/monalisa/followers",
-      "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
-      "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
-      "organizations_url": "https://api.github.com/users/monalisa/orgs",
-      "repos_url": "https://api.github.com/users/monalisa/repos",
-      "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/monalisa/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "privacy_level": "private",
-    "tier": {
-      "node_id": "MDEyOlNwb25zb3JzVGllcjE=",
-      "created_at": "2019-12-20T19:17:05Z",
-      "description": "foo",
-      "monthly_price_in_cents": 500,
-      "monthly_price_in_dollars": 5,
-      "name": "$5 a month",
-      "is_one_time": false,
-      "is_custom_amount": false
-    }
-  },
-  "changes": {
-    "tier": {
-      "from": {
-        "node_id": "MDEyOlNwb25zb3JzVGllcjI=",
-        "created_at": "2019-12-20T19:26:26Z",
-        "description": "bar",
-        "monthly_price_in_cents": 1000,
-        "monthly_price_in_dollars": 10,
-        "name": "$10 a month"
-      }
-    }
-  },
-  "effective_date": "2019-12-30T00:00:00+00:00",
-  "sender": {
-    "login": "monalisa",
-    "id": 2,
-    "node_id": "MDQ6VXNlcjI=",
-    "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/monalisa",
-    "html_url": "https://github.com/monalisa",
-    "followers_url": "https://api.github.com/users/monalisa/followers",
-    "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
-    "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
-    "organizations_url": "https://api.github.com/users/monalisa/orgs",
-    "repos_url": "https://api.github.com/users/monalisa/repos",
-    "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/monalisa/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - - - star -

    -

    - Activity related to a repository being starred. The type of activity is - specified in the action property of the payload object. For - more information, see the "starring" REST API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created or - deleted. -
    starred_atstring - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "starred_at": "2019-05-15T15:20:40Z",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:40Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - status -

    -

    - When the status of a Git commit changes. For more information, see the - "statuses" REST - API. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Commit statuses permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    idintegerThe unique identifier of the status.
    shastringThe Commit SHA.
    statestring - The new state. Can be pending, success, - failure, or error. -
    descriptionstring - The optional human-readable description added to the status. -
    target_urlstringThe optional link added to the status.
    branchesarray - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "id": 6805126730,
-  "sha": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-  "name": "Codertocat/Hello-World",
-  "target_url": null,
-  "context": "default",
-  "description": null,
-  "state": "success",
-  "commit": {
-    "sha": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "node_id": "MDY6Q29tbWl0MTg2ODUzMDAyOjYxMTM3MjhmMjdhZTgyYzdiMWExNzdjOGQwM2Y5ZTk2ZTBhZGYyNDY=",
-    "commit": {
-      "author": {
-        "name": "Codertocat",
-        "email": "21031067+Codertocat@users.noreply.github.com",
-        "date": "2019-05-15T15:19:25Z"
-      },
-      "committer": {
-        "name": "GitHub",
-        "email": "noreply@github.com",
-        "date": "2019-05-15T15:19:25Z"
-      },
-      "message": "Initial commit",
-      "tree": {
-        "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4",
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4"
-      },
-      "url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-      "comment_count": 1,
-      "verification": {
-        "verified": true,
-        "reason": "valid",
-        "signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJc3C39CRBK7hj4Ov3rIwAAdHIIABvaC0PQWgtUDQ5cz8ISR/Gf\npQYSuDMeeRa90wXzafPYowzID+UNU2eaRD4ak1bhb7kYVsZnPhUt5jTLKzr4Zuq8\nvt9ucrUvLDQWUZe2jX4wipM8ykWIlDho+9OAoocbVAn0kPBZEqJK74fH0Uj8vUfw\nIX71oq7XYsd2iGi9iMrYczr3aTe4EyQoYj/R+aAuRlLwU5LVciuyl0AmxMQXJ+qn\nowTpROWvXb1HijQZgx2x1lAEBzvahOiayOsJ+ZZ1DZX1lpXaSoeAjth1t2ckHlWW\n907fehmtX2cfccfrTLJC55QdhWU305ZtUoNRTp7TrdUecXnQcWKFcMmE/Yx1vps=\n=LQlK\n-----END PGP SIGNATURE-----\n",
-        "payload": "tree 1b13fc88733f95cc8cb16170f6990ef30d78acf4\nauthor Codertocat <21031067+Codertocat@users.noreply.github.com> 1557933565 -0500\ncommitter GitHub <noreply@github.com> 1557933565 -0500\n\nInitial commit"
-      }
-    },
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "html_url": "https://github.com/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/commits/6113728f27ae82c7b1a177c8d03f9e96e0adf246/comments",
-    "author": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "committer": {
-      "login": "web-flow",
-      "id": 19864447,
-      "node_id": "MDQ6VXNlcjE5ODY0NDQ3",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/19864447?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/web-flow",
-      "html_url": "https://github.com/web-flow",
-      "followers_url": "https://api.github.com/users/web-flow/followers",
-      "following_url": "https://api.github.com/users/web-flow/following{/other_user}",
-      "gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
-      "organizations_url": "https://api.github.com/users/web-flow/orgs",
-      "repos_url": "https://api.github.com/users/web-flow/repos",
-      "events_url": "https://api.github.com/users/web-flow/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/web-flow/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "parents": []
-  },
-  "branches": [
-    {
-      "name": "master",
-      "commit": {
-        "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/f95f852bd8fca8fcc58a9a2d6c842781e32a215e"
-      },
-      "protected": false
-    },
-    {
-      "name": "changes",
-      "commit": {
-        "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/ec26c3e57ca3a959ca5aad62de7213c562f8c821"
-      },
-      "protected": false
-    },
-    {
-      "name": "gh-pages",
-      "commit": {
-        "sha": "507fc9acd0d04ac4a9db87d12cb228c052cd813a",
-        "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/507fc9acd0d04ac4a9db87d12cb228c052cd813a"
-      },
-      "protected": false
-    }
-  ],
-  "created_at": "2019-05-15T15:20:55+00:00",
-  "updated_at": "2019-05-15T15:20:55+00:00",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:41Z",
-    "pushed_at": "2019-05-15T15:20:52Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - team -

    -

    - Activity related to an organization's team. The type of activity is - specified in the action property of the payload object. For - more information, see the "teams" - REST API. -

    -

    - - - - Availability -

    -
      -
    • Organization webhooks
      • -
    • GitHub Apps with Members permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - deleted, edited, - added_to_repository, or - removed_from_repository. -
    teamobjectThe team itself.
    changesobject - The changes to the team if the action was edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[privacy][from]string - The previous version of the team's privacy if the action was - edited. -
    changes[repository][permissions][from][admin]boolean - The previous version of the team member's - admin permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][pull]boolean - The previous version of the team member's - pull permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][push]boolean - The previous version of the team member's - push permission on a repository, if the action was - edited. -
    repositoryobject - The repository that was added or removed from to the team's - purview if the action was added_to_repository, - removed_from_repository, or edited. For - edited actions, repository also contains - the team's new permission levels for the repository. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "added_to_repository",
-  "team": {
-    "name": "github",
-    "id": 3253328,
-    "node_id": "MDQ6VGVhbTMyNTMzMjg=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://api.github.com/teams/3253328",
-    "html_url": "https://github.com/orgs/Octocoders/teams/github",
-    "members_url": "https://api.github.com/teams/3253328/members{/member}",
-    "repositories_url": "https://api.github.com/teams/3253328/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 186853261,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 38302899,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Octocoders",
-      "html_url": "https://github.com/Octocoders",
-      "followers_url": "https://api.github.com/users/Octocoders/followers",
-      "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-      "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-      "repos_url": "https://api.github.com/users/Octocoders/repos",
-      "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://api.github.com/repos/Octocoders/Hello-World",
-    "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T15:20:42Z",
-    "updated_at": "2019-05-15T15:20:45Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Octocoders/Hello-World.git",
-    "ssh_url": "git@github.com:Octocoders/Hello-World.git",
-    "clone_url": "https://github.com/Octocoders/Hello-World.git",
-    "svn_url": "https://github.com/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "permissions": {
-      "pull": true,
-      "push": false,
-      "admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - team_add -

    -

    - When a - repository is added to a team. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Members permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    teamobject - The team that was modified. - Note: Older events may not include this in the - payload. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "team": {
-    "name": "github",
-    "id": 3253328,
-    "node_id": "MDQ6VGVhbTMyNTMzMjg=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://api.github.com/teams/3253328",
-    "html_url": "https://github.com/orgs/Octocoders/teams/github",
-    "members_url": "https://api.github.com/teams/3253328/members{/member}",
-    "repositories_url": "https://api.github.com/teams/3253328/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 186853261,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 38302899,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Octocoders",
-      "html_url": "https://github.com/Octocoders",
-      "followers_url": "https://api.github.com/users/Octocoders/followers",
-      "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-      "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-      "repos_url": "https://api.github.com/users/Octocoders/repos",
-      "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://api.github.com/repos/Octocoders/Hello-World",
-    "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T15:20:42Z",
-    "updated_at": "2019-05-15T15:20:45Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Octocoders/Hello-World.git",
-    "ssh_url": "git@github.com:Octocoders/Hello-World.git",
-    "clone_url": "https://github.com/Octocoders/Hello-World.git",
-    "svn_url": "https://github.com/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "url": "https://api.github.com/orgs/Octocoders",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 38302899,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Octocoders",
-    "html_url": "https://github.com/Octocoders",
-    "followers_url": "https://api.github.com/users/Octocoders/followers",
-    "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-    "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-    "repos_url": "https://api.github.com/users/Octocoders/repos",
-    "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - watch -

    -

    - When someone stars a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "starring" REST API. -

    -

    - The event’s actor is the user who - starred a repository, and the event’s repository is the - repository that was starred. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Metadata permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - started. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "started",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:40Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - - - workflow_dispatch -

    -

    - This event occurs when someone triggers a workflow run on GitHub or - sends a POST request to the "Create a workflow dispatch event" - endpoint. For more information, see "Events that trigger - workflows." -

    -

    - - - - Availability -

    -
      -
    • GitHub Apps with Contents permission
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    inputsobject - Inputs to the workflow. Each key represents the name of the input - while its value represents the value of that input. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    refstringThe branch or tag from which the workflow was run.
    repositoryobject - The - repository - where the event occurred. -
    senderobjectThe user that triggered the event.
    workflowstring - Relative path to the workflow file which contains the workflow. -
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "inputs": {
-    "name": "Mona the Octocat"
-  },
-  "organization": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": null,
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "id": 79927191,
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "login": "octo-org",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "url": "https://api.github.com/orgs/octo-org"
-  },
-  "ref": "refs/heads/main",
-  "repository": {
-    "allow_forking": true,
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "created_at": "2021-08-16T21:34:28Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "fork": false,
-    "forks": 1,
-    "forks_count": 1,
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "full_name": "octo-org/octo-repo",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "id": 6811672,
-    "is_template": false,
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "mirror_url": null,
-    "name": "octo-repo",
-    "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "open_issues": 97,
-    "open_issues_count": 97,
-    "owner": {
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/octo-org",
-      "id": 79927191,
-      "login": "octo-org",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/octo-org"
-    },
-    "private": false,
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "pushed_at": "2022-01-07T21:57:21Z",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "size": 144,
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "topics": [],
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "updated_at": "2022-01-07T21:57:24Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "visibility": "public",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/25328854?v=4",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/octocat",
-    "id": 25328754,
-    "login": "octocat",
-    "node_id": "MDQ6VXNlcjI1MzI4ODU0",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/octocat"
-  },
-  "workflow": ".github/workflows/hello-world-workflow.yml"
-}
-
    -
    -

    - - - - workflow_job -

    -

    - A GitHub Actions workflow job has been queued, is in progress, or has - been completed on a repository. The type of activity is specified in the - action property of the payload object. -

    -

    - - - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • Enterprise webhooks
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • queued - A new job was created.
      • -
    • - in_progress - The job has started processing on - the runner. -
      • -
    • - completed - The status of the job is - completed. -
      • -
    -
    workflow_jobobject - The workflow job. Many workflow_job keys, such as - head_sha, conclusion, and - started_at are the same as those in a - check_run object. -
    workflow_job[status]string - The current status of the job. Can be queued, - in_progress, or completed. -
    workflow_job[labels]array - Custom labels for the job. Specified by the - "runs-on" - attribute - in the workflow YAML. -
    workflow_job[runner_id]integer - The ID of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_name]string - The name of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_id]integer - The ID of the runner group that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_name]string - The name of the runner group that is running this job. This will - be null as long as - workflow_job[status] is queued. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "in_progress",
-  "workflow_job": {
-    "id": 2832853555,
-    "run_id": 940463255,
-    "run_url": "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255",
-    "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55",
-    "head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055",
-    "url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555",
-    "html_url": "https://github.com/octo-org/example-workflow/runs/2832853555",
-    "status": "in_progress",
-    "conclusion": null,
-    "started_at": "2021-06-15T19:22:27Z",
-    "completed_at": null,
-    "name": "Test workflow",
-    "steps": [
-      {
-        "name": "Set up job",
-        "status": "in_progress",
-        "conclusion": null,
-        "number": 1,
-        "started_at": "2021-06-15T19:22:27.000Z",
-        "completed_at": null
-      }
-    ],
-    "check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555",
-    "labels": [
-      "gpu",
-      "db-app",
-      "dc-03"
-    ],
-    "runner_id": 1,
-    "runner_name": "my runner",
-    "runner_group_id": 2,
-    "runner_group_name": "my runner group"
-  },
-  "repository": {
-    "id": 376034443,
-    "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55",
-    "name": "example-workflow",
-    "full_name": "octo-org/example-workflow",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 33435655,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-      "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/example-workflow",
-    "description": "Test workflow",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/example-workflow",
-    "forks_url": "https://api.github.com/repos/octo-org/example-workflow/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/example-workflow/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/example-workflow/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/example-workflow/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/example-workflow/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/example-workflow/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/example-workflow/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/example-workflow/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/example-workflow/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/example-workflow/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/example-workflow/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/example-workflow/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/example-workflow/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/example-workflow/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/example-workflow/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/example-workflow/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/example-workflow/deployments",
-    "created_at": "2021-06-11T13:29:13Z",
-    "updated_at": "2021-06-11T13:33:01Z",
-    "pushed_at": "2021-06-11T13:32:58Z",
-    "git_url": "git://github.com/octo-org/example-workflow.git",
-    "ssh_url": "git@github.com:octo-org/example-workflow.git",
-    "clone_url": "https://github.com/octo-org/example-workflow.git",
-    "svn_url": "https://github.com/octo-org/example-workflow",
-    "homepage": null,
-    "size": 1,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 33435655,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "description": "octo-org"
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 319655,
-    "node_id": "MDQ6VXNlcjMxOTY1NQ55",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - - - workflow_run -

    -

    - When a GitHub Actions workflow run is requested or completed. For more - information, see "Events that trigger - workflows." -

    -

    - - - - Availability -

    -
      -
    • - GitHub Apps with Actions or - Contents permissions -
      • -
    -

    - - - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of - requested, in_progress, or - completed. -
    workflow_runobject - The workflow run. Includes information such as - artifacts_url, check_suite_id, - conclusion, head_branch, and - head_sha. -
    workflowobjectThe workflow that generated the workflow run.
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    repositoryobject - The - repository - where the event occurred. -
    senderobjectThe user that triggered the event.
    -

    - - - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "organization": {
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "description": "",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "id": 33435682,
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "login": "Codertocat",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "url": "https://api.github.com/orgs/Codertocat"
-  },
-  "repository": {
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "created_at": "2020-07-29T09:57:16Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "fork": false,
-    "forks": 0,
-    "forks_count": 0,
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "full_name": "Codertocat/Hello-World",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "id": 283462325,
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "mirror_url": null,
-    "name": "Hello-World",
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "open_issues": 0,
-    "open_issues_count": 0,
-    "owner": {
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/Codertocat",
-      "id": 33435682,
-      "login": "Codertocat",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/Codertocat"
-    },
-    "private": true,
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "pushed_at": "2020-07-29T10:06:16Z",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "size": 0,
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "updated_at": "2020-07-29T10:06:18Z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars3.githubusercontent.com/u/54248166?v=4",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/Codertocat",
-    "id": 54248166,
-    "login": "Codertocat",
-    "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/Codertocat"
-  },
-  "workflow": {
-    "badge_url": "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg",
-    "created_at": "2021-12-15T20:11:38.000Z",
-    "html_url": "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml",
-    "id": 16340987,
-    "name": "Manually triggered workflow",
-    "node_id": "W_kwDOF6lyTM4A-Vf7",
-    "path": ".github/workflows/syntax.yml",
-    "state": "active",
-    "updated_at": "2021-12-16T18:40:41.000Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  },
-  "workflow_run": {
-    "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts",
-    "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel",
-    "check_suite_id": 4683454167,
-    "check_suite_node_id": "CS_kwDOF6lyTM8AAAABFyfW1w",
-    "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167",
-    "conclusion": null,
-    "created_at": "2021-12-16T19:37:22Z",
-    "event": "workflow_dispatch",
-    "head_branch": "main",
-    "head_commit": {
-      "author": {
-        "email": "octocat@github.com",
-        "name": "Mona Lisa"
-      },
-      "committer": {
-        "email": "noreply@github.com",
-        "name": "GitHub"
-      },
-      "id": "5779607b49aab1200488439f02372c57b4f75444",
-      "message": "Update milestone-created.yml",
-      "timestamp": "2021-12-16T19:37:14Z",
-      "tree_id": "8181cee091cf9627ac07c3cc4b94c015a1d56706"
-    },
-    "head_repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "head_sha": "5779607b49aab1200488439f02372c57b4f75444",
-    "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1589141559",
-    "id": 1589141559,
-    "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs",
-    "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs",
-    "name": "Manually triggered workflow",
-    "node_id": "WFR_kwLOF6lyTM5euGA3",
-    "previous_attempt_url": null,
-    "pull_requests": [],
-    "repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun",
-    "run_attempt": 1,
-    "run_number": 36,
-    "run_started_at": "2021-12-16T19:37:22Z",
-    "status": "queued",
-    "updated_at": "2021-12-16T19:37:22Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559",
-    "workflow_id": 16340987,
-    "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  }
-}
-
    +
    +
    +

    + workflow_run +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for workflow_run

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for workflow_run

    +
    +
    + +
    +
    +
    +

    + A workflow run finished. This event occurs when a workflow run + is completed, regardless of whether the workflow was successful + or unsuccessful. +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -
    \ No newline at end of file +
    diff --git a/cache/ghes-33/webhook-events-and-payloads.html b/cache/ghes-33/webhook-events-and-payloads.html index 3ef5cdfd3..e8d3d5b5c 100644 --- a/cache/ghes-33/webhook-events-and-payloads.html +++ b/cache/ghes-33/webhook-events-and-payloads.html @@ -6,10 +6,10 @@

    In this article

    +

    Webhook payload example

    +
    + { "action": "completed", "check_suite": { "id": 9, "node_id": + "MDEwOkNoZWNrU3VpdGU5", "head_branch": "changes", "head_sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "status": "completed", + "conclusion": "success", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9", + "before": "4544205a385319fd846d5df4ed2e3b8173529d78", "after": + "14977a7b5485400124827221a04bfb474bcd72d1", "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ], "app": { "id": 2, "node_id": + "MDM6QXBwMg==", "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.github.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:39:09Z", + "latest_check_runs_count": 1, "check_runs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs", + "head_commit": { "id": "14977a7b5485400124827221a04bfb474bcd72d1", + "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea", "message": + "Update README.md", "timestamp": "2019-05-15T19:38:01Z", "author": + { "name": "Codertocat", "email": "Codertocat@octocoders.github.io" + }, "committer": { "name": "Codertocat", "email": + "Codertocat@octocoders.github.io" } } }, "repository": { "id": + 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - check_suite -

    -

    - Check suite activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check suites" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    +
    +

    + code_scanning_alert +

    +
    +
    + Activity related to code scanning alerts in a repository. The type + of activity is specified in the action property of the payload + object. For more information, see "About code scanning." +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Code scanning alerts permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. This can be one of + created, reopened_by_user, + closed_by_user, fixed, + appeared_in_branch, or + reopened. +
    +
    +
    +
    +
    +
    +
    alertobject
    +
    +
    + The code scanning alert involved in the event. +
    +
    +
    +
    +
    +
    +
    refstring
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    commit_oidstring
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    + If the action is + reopened_by_user or + closed_by_user, the + sender object will be the user that + triggered the event. The sender object + is github-enterprise for all other + actions. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "reopened", "alert": { "number": 10, "created_at": + "2020-07-22T14:06:31Z", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10", + "instances": [ { "ref": "refs/heads/main", "analysis_key": + ".github/workflows/workflow.yml:upload", "environment": "{}", + "state": "open" } ], "state": "open", "dismissed_by": null, + "dismissed_at": null, "dismissed_reason": null, "rule": { "id": + "Style/FrozenStringLiteralComment", "severity": "note", + "description": "Add the frozen_string_literal comment to the top + of files to help transition to frozen string literals by default." + }, "tool": { "name": "Rubocop", "version": null } }, "ref": + "refs/heads/main", "commit_oid": + "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": + 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", "updated_at": + "2019-05-15T15:19:27Z", "pushed_at": "2019-05-15T15:20:32Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "main" }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be: -
      -
    • - completed - All check runs in a check suite have - completed. -
      • -
    • - requested - Occurs when new code is pushed to the - app's repository. When you receive the - requested action events, you'll need to - create a new check run. -
      • -
    • - rerequested - Occurs when someone requests to - re-run the entire check suite from the pull request UI. When - you receive the rerequested action events, you'll - need to - create a new check run. See "About status checks" for more details about the GitHub UI. -
      • -
    -
    check_suiteobject - The - check_suite. -
    check_suite[head_branch]stringThe head branch name the changes are on.
    check_suite[head_sha]stringThe SHA of the most recent commit for this check suite.
    check_suite[status]string - The summary status for all check runs that are part of the check - suite. Can be queued, requested, - in_progress, or completed. -
    check_suite[conclusion]string - The summary conclusion for all check runs that are part of the - check suite. Can be one of success, - failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_suite[url]stringURL that points to the check suite API resource.
    check_suite[pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    repositoryobject - The - repository +
    organizationobject - Webhook payloads contain the - organizationcommit_comment + +
    +
    + A commit comment is created. The type of activity is specified in + the action property of the payload object. For more + information, see the "commit comment" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "check_suite": {
-    "id": 9,
-    "node_id": "MDEwOkNoZWNrU3VpdGU5",
-    "head_branch": "changes",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "status": "completed",
-    "conclusion": "success",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-    "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.github.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:39:09Z",
-    "latest_check_runs_count": 1,
-    "check_runs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs",
-    "head_commit": {
-      "id": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
-      "message": "Update README.md",
-      "timestamp": "2019-05-15T19:38:01Z",
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@octocoders.github.io"
-      },
-      "committer": {
-        "name": "Codertocat",
-        "email": "Codertocat@octocoders.github.io"
-      }
-    }
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    commentobject
    +
    +
    + The + commit comment + resource. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "action": "created", "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2", + "id": 2, "node_id": "MDEzOkNvbW1pdENvbW1lbnQy", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "position": null, "line": + null, "path": null, "commit_id": + "4544205a385319fd846d5df4ed2e3b8173529d78", "created_at": + "2019-05-15T19:38:09Z", "updated_at": "2019-05-15T19:38:09Z", + "author_association": "OWNER", "body": "This is a really good + change! :+1:" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - code_scanning_alert -

    -

    - Activity related to code scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see "About code scanning." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - created, reopened_by_user, - closed_by_user, fixed, - appeared_in_branch, or reopened. -
    alertobjectThe code scanning alert involved in the event.
    refstring - 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. -
    commit_oidstring - 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. -
    repositoryobject - The - repository +
    +

    +

    organizationobject - Webhook payloads contain the - organizationcontent_reference + +
    +
    + A new content reference is created. A new content + reference is created when the body or comment of an issue or pull + request includes a URL that matches a configured content reference + domain. For more information, see "Using content attachments" to learn more about content references and attachments.Webhook + events are triggered based on the specificity of the domain you + register. For example, if you register a subdomain + (https://subdomain.example.com) then only URLs for + the subdomain trigger this event. If you register a domain + (https://example.com) then URLs for domain and all + subdomains trigger this event. See "Create a content attachment" to create a new content attachment. +
    +

    Availability

    +
      +
    • + GitHub Apps with the + content_references:write permission +
      • +
    +

    Webhook payload object

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is reopened_by_user or - closed_by_user, the sender object will - be the user that triggered the event. The - sender object is github-enterprise for - all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 10,
-    "created_at": "2020-07-22T14:06:31Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
-    "instances": [
-      {
-        "ref": "refs/heads/main",
-        "analysis_key": ".github/workflows/workflow.yml:upload",
-        "environment": "{}",
-        "state": "open"
-      }
-    ],
-    "state": "open",
-    "dismissed_by": null,
-    "dismissed_at": null,
-    "dismissed_reason": null,
-    "rule": {
-      "id": "Style/FrozenStringLiteralComment",
-      "severity": "note",
-      "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default."
-    },
-    "tool": {
-      "name": "Rubocop",
-      "version": null
-    }
-  },
-  "ref": "refs/heads/main",
-  "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  }
-}
-
    +
    Headers
    Name, Type, Description
    + + +

    Webhook payload example

    +
    + { "action": "created", "content_reference": { "id": 17, + "node_id": "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA5", "reference": + "https://errors.ai/" }, "repository": { "id": 145551601, + "node_id": "MDEwOlJlcG9zaXRvcnkxNDU1NTE2MDE=", "name": + "hello-world", "full_name": "octocoders/hello-world", "private": + true, "owner": { "login": "Codertocat", "id": 7718702, "node_id": + "MDQ6VXNlcjc3MTg3MDI=", "avatar_url": + "https://avatars1.githubusercontent.com/u/7718702?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": true }, "html_url": + "https://github.com/Codertocat/hello-world", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/hello-world", + "forks_url": + "https://api.github.com/repos/Codertocat/hello-world/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/hello-world/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/hello-world/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/hello-world/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/hello-world/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/hello-world/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/hello-world/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/hello-world/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/hello-world/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/hello-world/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/hello-world/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/hello-world/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/hello-world/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/hello-world/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/hello-world/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/hello-world/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/hello-world/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/hello-world/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/hello-world/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/hello-world/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/hello-world/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/hello-world/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/hello-world/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/hello-world/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/hello-world/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/hello-world/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/hello-world/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/hello-world/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/hello-world/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/hello-world/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/hello-world/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/hello-world/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/hello-world/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/hello-world/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/hello-world/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/hello-world/deployments", + "created_at": "2018-08-21T10:58:58Z", "updated_at": + "2018-08-21T10:59:01Z", "pushed_at": "2018-08-21T10:59:00Z", + "git_url": "git://github.com/Codertocat/hello-world.git", + "ssh_url": "git@github.com:Codertocat/hello-world.git", + "clone_url": "https://github.com/Codertocat/hello-world.git", + "svn_url": "https://github.com/Codertocat/hello-world", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 2, "license": null, + "forks": 0, "open_issues": 2, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 7718702, + "node_id": "MDQ6VXNlcjc3MTg3MDI=", "avatar_url": + "https://avatars1.githubusercontent.com/u/7718702?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": true }, "installation": { "id": 371641, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzcxNjQx" } + } +
    + -

    - - commit_comment -

    -

    - A commit comment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "commit comment" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    commentobject - The - commit comment +
    +

    +

    repositoryobject - The - repositorycreate + +
    +
    +

    + Note: You will not receive a webhook for this + event when you create more than three tags at once. +

    + A Git branch or tag is created. For more information, see the "Git database" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    refstring
    +
    +
    + The + git ref + resource. +
    +
    +
    +
    +
    +
    +
    ref_typestring
    +
    +
    + The type of Git ref object created in the + repository. Can be either branch or + tag. +
    +
    +
    +
    +
    +
    +
    master_branchstring
    +
    +
    + The name of the repository's default branch (usually + main). +
    +
    +
    +
    +
    +
    +
    descriptionstring
    +
    +
    The repository's current description.
    +
    +
    +
    +
    +
    +
    pusher_typestring
    +
    +
    + The pusher type for the event. Can be either + user or a deploy key. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "simple-tag", "ref_type": "tag", "master_branch": + "master", "description": null, "pusher_type": "user", + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:22Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + + +
    +
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2",
-    "id": 2,
-    "node_id": "MDEzOkNvbW1pdENvbW1lbnQy",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "position": null,
-    "line": null,
-    "path": null,
-    "commit_id": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "created_at": "2019-05-15T19:38:09Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "author_association": "OWNER",
-    "body": "This is a really good change! :+1:"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    + delete + +
    +
    +

    + Note: You will not receive a webhook for this + event when you delete more than three tags at once. +

    + A Git branch or tag is deleted. For more information, see the "Git database" REST API. +
    +

    Availability

    + +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    refstring
    +
    +
    + The + git ref + resource. +
    +
    +
    +
    +
    +
    +
    ref_typestring
    +
    +
    + The type of Git ref object deleted in the + repository. Can be either branch or + tag. +
    +
    +
    +
    +
    +
    +
    pusher_typestring
    +
    +
    + The pusher type for the event. Can be either + user or a deploy key. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "simple-tag", "ref_type": "tag", "pusher_type": "user", + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - content_reference -

    -

    - A new content reference is created. A new content reference - is created when the body or comment of an issue or pull request includes - a URL that matches a configured content reference domain. For more - information, see "Using content attachments" to learn more about content references and attachments. -

    -

    - Webhook events are triggered based on the specificity of the domain you - register. For example, if you register a subdomain - (https://subdomain.example.com) then only URLs for the - subdomain trigger this event. If you register a domain - (https://example.com) then URLs for domain and all - subdomains trigger this event. See "Create a content attachment" to create a new content attachment. -

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "content_reference": {
-    "id": 17,
-    "node_id": "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA5",
-    "reference": "https://errors.ai/"
-  },
-  "repository": {
-    "id": 145551601,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNDU1NTE2MDE=",
-    "name": "hello-world",
-    "full_name": "octocoders/hello-world",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 7718702,
-      "node_id": "MDQ6VXNlcjc3MTg3MDI=",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "html_url": "https://github.com/Codertocat/hello-world",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world/deployments",
-    "created_at": "2018-08-21T10:58:58Z",
-    "updated_at": "2018-08-21T10:59:01Z",
-    "pushed_at": "2018-08-21T10:59:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world.git",
-    "clone_url": "https://github.com/Codertocat/hello-world.git",
-    "svn_url": "https://github.com/Codertocat/hello-world",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 7718702,
-    "node_id": "MDQ6VXNlcjc3MTg3MDI=",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  },
-  "installation": {
-    "id": 371641,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzcxNjQx"
-  }
-}
-
    +
    +
    +

    + deploy_key +

    +
    +
    + A deploy key is added or removed from a repository. The type of + activity is specified in the action property of the + payload object. For more information, see the "Deploy keys" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be either + created or deleted. +
    +
    +
    +
    +
    +
    +
    keyobject
    +
    +
    + The + deploy key + resource. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "key": { "id": 100, "key": "ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z", + "url": + "https://api.github.com/repos/Codertocat/Hello-World/keys/100", + "title": "hey-its-a-deploy-key", "verified": true, "created_at": + "2019-04-02T17:37:07Z", "read_only": true }, "repository": { "id": + 135493233, "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "owner": { + "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "private": false, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-05-30T20:18:04Z", "updated_at": + "2018-05-30T20:18:50Z", "pushed_at": "2018-05-30T20:18:48Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 1, "license": null, + "forks": 0, "open_issues": 1, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    -

    - - create -

    -

    - A Git branch or tag is created. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you create more than three tags at once. -

    +
    +

    + deployment +

    +
    +
    + A deployment is created. The type of activity is specified in the + action property of the payload object. For more + information, see the "deployment" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Deployments permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    deploymentobject
    +
    +
    + The + deployment. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "deployment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "id": 2, "node_id": "MDEwOkRlcGxveW1lbnQy", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "ref": "master", + "task": "deploy", "payload": {}, "original_environment": + "production", "environment": "production", "description": null, + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:20Z", "updated_at": "2019-05-15T19:38:20Z", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The - git ref +
    ref_typestring - The type of Git ref object created in the repository. Can be - either branch or tag. -
    master_branchstring - The name of the repository's default branch (usually - main). -
    descriptionstringThe repository's current description.
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repositorydeployment_status + +
    +
    + A deployment is created. The type of activity is specified in the + action property of the payload object. For more + information, see the "deployments" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Deployments permission
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    + deployment_statusobject +
    +
    +
    + The + deployment status. +
    +
    +
    +
    +
    +
    +
    + deployment_status["state"]string +
    +
    +
    + The new state. Can be pending, + success, failure, or + error. +
    +
    +
    +
    +
    +
    +
    + deployment_status["target_url"]string +
    +
    +
    The optional link added to the status.
    +
    +
    +
    +
    +
    +
    + deployment_status["description"]string +
    +
    +
    + The optional human-readable description added to the + status. +
    +
    +
    +
    +
    +
    +
    deploymentobject
    +
    +
    + The + deployment + that this status is associated with. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "deployment_status": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2", + "id": 2, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy", "state": + "success", "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "description": "", + "environment": "production", "target_url": "", "created_at": + "2019-05-15T19:38:21Z", "updated_at": "2019-05-15T19:38:21Z", + "deployment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "deployment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "id": 2, "node_id": "MDEwOkRlcGxveW1lbnQy", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "ref": "master", + "task": "deploy", "payload": {}, "original_environment": + "production", "environment": "production", "description": null, + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:20Z", "updated_at": "2019-05-15T19:38:21Z", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + + +
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "master_branch": "master",
-  "description": null,
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:22Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    + enterprise + +
    +
    + A site or repository administrator enables or disables anonymous + Git read access. See "Allowing admins to enable anonymous Git read access to public + repositories" for more details. This event is not available in the Events + API. +
    +

    Availability

    +
      +
    • + GitHub Enterprise webhooks. For more information, "Global webhooks." +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be + anonymous_access_enabled or + anonymous_access_disabled. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "anonymous_access_enabled", "sender": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://avatars.octocoders.github.io/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": true } } +
    +
    -

    - - delete -

    -

    - A Git branch or tag is deleted. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you delete more than three tags at once. -

    +
    +

    + fork +

    +
    +
    + A user forks a repository. For more information, see the "forks" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    forkeeobject
    +
    +
    + The created + repository + resource. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "forkee": { "id": 120, "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=", + "name": "Hello-World", "full_name": "Octocoders/Hello-World", + "private": false, "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master", "public": true }, "repository": { + "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "installation": { + "id": 5, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } + } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The - git ref +
    +

    +

    ref_typestring - The type of Git ref object deleted in the repository. Can be - either branch or tag. -
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repositorygithub_app_authorization + +
    +
    + When someone revokes their authorization of a GitHub App, this + event occurs. A GitHub App receives this webhook by default and + cannot unsubscribe from this event.Anyone 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 + user-to-server requests, which require GitHub App authorization, + see "Identifying and authorizing users for GitHub Apps." +
    +

    Availability

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be revoked. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "revoked", "sender": { "login": "octocat", "id": 1, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": false } } +
    + + +
    +
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    + gollum + +
    +
    + A wiki page is created or updated. For more information, see "About wikis." +
    +

    Availability

    + +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    pagesarray
    +
    +
    The pages that were updated.
    +
    +
    +
    +
    +
    +
    + pages[][page_name]string +
    +
    +
    The name of the page.
    +
    +
    +
    +
    +
    +
    + pages[][title]string +
    +
    +
    The current page title.
    +
    +
    +
    +
    +
    +
    + pages[][action]string +
    +
    +
    + The action that was performed on the page. Can be + created or edited. +
    +
    +
    +
    +
    +
    +
    pages[][sha]string
    +
    +
    The latest commit SHA of the page.
    +
    +
    +
    +
    +
    +
    + pages[][html_url]string +
    +
    +
    Points to the HTML wiki page.
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "pages": [ { "page_name": "Home", "title": "Home", "summary": + null, "action": "edited", "sha": + "4bbb6df16cb5ce1818602bf634e94ebdac7ae385", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home" } + ], "repository": { "id": 122, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjI=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "owner": { "login": "Codertocat", "id": + 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://avatars.octocoders.github.io/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "private": false, + "html_url": "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-10-04T18:29:19Z", "updated_at": + "2018-10-04T18:29:21Z", "pushed_at": "2018-10-04T18:29:59Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 0, "license": null, + "forks": 0, "open_issues": 0, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "rachmari", "id": 3, "node_id": + "MDQ6VXNlcjM=", "avatar_url": + "https://avatars.octocoders.github.io/u/3?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/rachmari", + "html_url": "https://octocoders.github.io/rachmari", + "followers_url": + "https://octocoders.github.io/api/v3/users/rachmari/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/rachmari/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/rachmari/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/rachmari/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/rachmari/received_events", + "type": "User", "site_admin": true } } +
    +
    -

    - - deploy_key -

    -

    - A deploy key is added or removed from a repository. The type of activity - is specified in the action property of the payload object. - For more information, see the "Deploy keys" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be either created or - deleted. -
    keyobject - The - deploy key +
    +

    +

    repositoryobject - The - repositoryinstallation + +
    +
    + Activity related to a GitHub App installation. The type of + activity is specified in the action property of the + payload object. For more information, see the "GitHub App installation" REST API. +
    +

    Availability

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + created - Someone installs a GitHub + App. +
      • +
    • + deleted - Someone uninstalls a + GitHub App +
      • +
    • + suspend - Someone suspends a GitHub + App installation. +
      • +
    • + unsuspend - Someone unsuspends a + GitHub App installation. +
      • +
    • + new_permissions_accepted - Someone + accepts new permissions for a GitHub App + installation. When a GitHub App owner requests + new permissions, the person who installed the + GitHub App must accept the new permissions + request. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repositoriesarray
    +
    +
    + An array of repository objects that the installation + can access. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    The GitHub App installation.
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "deleted", "installation": { "id": 5, "account": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?", + "gravatar_id": "", "url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat", + "followers_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers", + "following_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs", + "repos_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos", + "events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repository_selection": + "selected", "access_tokens_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens", + "repositories_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5", + "app_id": 2, "target_id": 4, "target_type": "User", "permissions": + { "administration": "write", "checks": "write", "contents": + "write", "deployments": "write", "issues": "write", "pages": + "write", "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "statuses": "write", + "repository_pre_receive_hooks": "write", "metadata": "read", + "vulnerability_alerts": "read" }, "events": [ "check_run", + "check_suite", "commit_comment", "create", "delete", "deployment", + "deployment_status", "fork", "gollum", "issues", "issue_comment", + "label", "member", "membership", "milestone", "organization", + "page_build", "project", "project_card", "project_column", + "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ], "created_at": + "2019-05-15T19:37:38.000Z", "updated_at": + "2019-05-15T19:37:38.000Z", "single_file_name": null }, + "enterprise": { "id": 1, "slug": "github", "name": "GitHub", + "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github", + "created_at": "2019-05-14T19:31:12Z", "updated_at": + "2019-05-14T19:31:12Z" }, "sender": { "login": "Codertocat", "id": + 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?", + "gravatar_id": "", "url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat", + "followers_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers", + "following_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs", + "repos_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos", + "events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    + + +
    +
    +

    + installation_repositories +

    +
    +
    + Activity related to repositories being added to a GitHub App + installation. The type of activity is specified in the + action property of the payload object. For more + information, see the "GitHub App installation" REST API. +
    +

    Availability

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be either + added or removed. +
    +
    +
    +
    +
    +
    +
    + repository_selectionstring +
    +
    +
    + The choice of repositories the installation is on. + Can be either selected or + all. +
    +
    +
    +
    +
    +
    +
    + repositories_addedarray +
    +
    +
    + An array of repository objects, which were added to + the installation. +
    +
    +
    +
    +
    +
    +
    + repositories_removedarray +
    +
    +
    + An array of repository objects, which were removed + from the installation. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    The GitHub App installation.
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added", "installation": { "id": 5, "account": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repository_selection": + "selected", "access_tokens_url": + "https://octocoders.github.io/api/v3/app/installations/5/access_tokens", + "repositories_url": + "https://octocoders.github.io/api/v3/installation/repositories", + "html_url": + "https://octocoders.github.io/settings/installations/5", "app_id": + 2, "target_id": 4, "target_type": "User", "permissions": { + "administration": "write", "repository_pre_receive_hooks": + "write", "statuses": "write", "repository_projects": "write", + "repository_hooks": "write", "pull_requests": "write", "pages": + "write", "issues": "write", "deployments": "write", "contents": + "write", "checks": "write", "vulnerability_alerts": "read", + "metadata": "read" }, "events": [ "check_run", "check_suite", + "commit_comment", "create", "delete", "deployment", + "deployment_status", "fork", "gollum", "issues", "issue_comment", + "label", "member", "membership", "milestone", "organization", + "page_build", "project", "project_card", "project_column", + "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ], "created_at": 1557949058, + "updated_at": 1557949058, "single_file_name": null }, + "repository_selection": "selected", "repositories_added": [ { + "id": 119, "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=", "name": "Space", + "full_name": "Codertocat/Space", "private": false } ], + "repositories_removed": [], "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + issue_comment +

    +
    +
    + Activity related to an issue or pull request comment. The type of + activity is specified in the action property of the + payload object. For more information, see the "issue comments" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Issues permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed on the comment. Can be + one of created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    issueobject
    +
    +
    + The + issue + the comment belongs to. +
    +
    +
    +
    +
    +
    +
    commentobject
    +
    +
    + The + comment + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "issue": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1", + "id": 10, "node_id": "MDU6SXNzdWUxMA==", "number": 1, "title": + "Spelling error in the README file", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "labels": [ { "id": 941, + "node_id": "MDU6TGFiZWw5NDE=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", "color": "d73a4a", "default": true } ], "state": + "open", "locked": false, "assignee": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "assignees": [ { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } ], "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 1, + "closed_issues": 0, "state": "closed", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:53Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": + "2019-05-15T19:37:53Z" }, "comments": 0, "created_at": + "2019-05-15T19:37:53Z", "updated_at": "2019-05-15T19:37:55Z", + "closed_at": null, "author_association": "OWNER", "body": "It + looks like you accidently spelled 'commit' with two 't's." }, + "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "id": 2, "node_id": "MDEyOklzc3VlQ29tbWVudDI=", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:37:55Z", "updated_at": "2019-05-15T19:37:55Z", + "author_association": "OWNER", "body": "You are totally right! + I'll get this fixed right away." }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 1, + "license": null, "forks": 0, "open_issues": 1, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + issues +

    +
    +
    + Activity related to an issue. The type of activity is specified in + the action property of the payload object. For more + information, see the "issues" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Issues permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of + opened, edited, + deleted, pinned, + unpinned, closed, + reopened, assigned, + unassigned, labeled, + unlabeled, locked, + unlocked, transferred, + milestoned, or + demilestoned. +
    +
    +
    +
    +
    +
    +
    issueobject
    +
    +
    + The + issue + itself. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the issue if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from]string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    assigneeobject
    +
    +
    + The optional user who was assigned or unassigned + from the issue. +
    +
    +
    +
    +
    +
    +
    labelobject
    +
    +
    + The optional label that was added or removed from + the issue. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "edited", "issue": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1", + "id": 10, "node_id": "MDU6SXNzdWUxMA==", "number": 1, "title": + "Spelling error in the README file", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "labels": [ { "id": 941, + "node_id": "MDU6TGFiZWw5NDE=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", "color": "d73a4a", "default": true } ], "state": + "open", "locked": false, "assignee": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "assignees": [ { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } ], "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 1, + "closed_issues": 0, "state": "closed", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:53Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": + "2019-05-15T19:37:53Z" }, "comments": 0, "created_at": + "2019-05-15T19:37:53Z", "updated_at": "2019-05-15T19:37:54Z", + "closed_at": null, "author_association": "OWNER", "body": "It + looks like you accidently spelled 'commit' with two 't's." }, + "changes": {}, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 1, + "license": null, "forks": 0, "open_issues": 1, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + label +

    +
    +
    + Activity related to a label. The type of activity is specified in + the action property of the payload object. For more + information, see the "labels" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be + created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    labelobject
    +
    +
    The label that was added.
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the label if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from]string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[color][from]string +
    +
    +
    + The previous version of the color if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "deleted", "label": { "id": 965, "node_id": + "MDU6TGFiZWw5NjU=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix", + "name": ":bug: Bugfix", "color": "cceeaa", "default": false }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + member +

    +
    +
    + Activity related to repository collaborators. The type of activity + is specified in the action property of the payload + object. For more information, see the "collaborators" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + added - A user accepts an + invitation to a repository. +
      • +
    • + removed - A user is removed as a + collaborator in a repository. +
      • +
    • + edited - A user's collaborator + permissions have changed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    memberobject
    +
    +
    + The + user + that was added. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the collaborator permissions if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[old_permission][from]string +
    +
    +
    + The previous permissions of the collaborator if the + action was edited. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added", "member": { "login": "Hacktocat", "id": 5, + "node_id": "MDQ6VXNlcjU=", "avatar_url": + "https://octocoders.github.io/avatars/u/5?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Hacktocat", + "html_url": "https://octocoders.github.io/Hacktocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/received_events", + "type": "User", "site_admin": false }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + membership +

    +
    +
    + Activity related to team membership. The type of activity is + specified in the action property of the payload + object. For more information, see the "team members" REST API. +
    +

    Availability

    +
      +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be + added or removed. +
    +
    +
    +
    +
    +
    +
    scopestring
    +
    +
    + The scope of the membership. Currently, can only be + team. +
    +
    +
    +
    +
    +
    +
    memberobject
    +
    +
    + The + user + that was added or removed. +
    +
    +
    +
    +
    +
    +
    teamobject
    +
    +
    + The + team + for the membership. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "removed", "scope": "team", "member": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "sender": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "team": { "name": "github", + "id": 3, "node_id": "MDQ6VGVhbTM=", "slug": "github", + "description": "Open-source team", "privacy": "secret", "url": + "https://octocoders.github.io/api/v3/teams/3", "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "organization": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" } + } +
    +
    +
    +
    +
    +

    + meta +

    +
    +
    + The webhook this event is configured on was deleted. This event + will only listen for changes to the particular hook the event is + installed on. Therefore, it must be selected for each hook that + you'd like to receive meta events for. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be deleted. +
    +
    +
    +
    +
    +
    +
    hook_idinteger
    +
    +
    The id of the modified webhook.
    +
    +
    +
    +
    +
    +
    hookobject
    +
    +
    + The modified webhook. This will contain different + keys based on the type of webhook it is: repository, + organization, business, app, or GitHub Marketplace. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "deleted", "hook_id": 101047067, "hook": { "type": + "Repository", "id": 101047067, "name": "web", "active": true, + "events": [ "meta" ], "config": { "content_type": "json", + "insecure_ssl": "0", "url": "http://example.com/hook" }, + "updated_at": "2019-04-10T03:57:12Z", "created_at": + "2019-04-10T03:57:12Z" }, "repository": { "id": 135493233, + "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "owner": { + "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "private": false, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-05-30T20:18:04Z", "updated_at": + "2018-05-30T20:18:50Z", "pushed_at": "2018-05-30T20:18:48Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 1, "license": null, + "forks": 0, "open_issues": 1, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + milestone +

    +
    +
    + Activity related to milestones. The type of activity is specified + in the action property of the payload object. For + more information, see the "milestones" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of + created, closed, + opened (a closed milestone is + re-opened), edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    milestoneobject
    +
    +
    The milestone itself.
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the milestone if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[description][from]string +
    +
    +
    + The previous version of the description if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[due_on][from]string +
    +
    +
    + The previous version of the due date if the action + was edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from]string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 0, + "closed_issues": 0, "state": "open", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:52Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": null }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + organization +

    +
    +
    + Activity related to an organization and its members. The type of + activity is specified in the action property of the + payload object. For more information, see the "organizations" REST API. +
    +

    Availability

    +
      +
    • + GitHub Enterprise webhooks only receive created and + deleted events. For more information, "Global webhooks. +
      • +
    • + Organization webhooks only receive the deleted, + added, removed, renamed, + and invited events +
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: + created, deleted, + renamed, member_added, + member_removed, or + member_invited. +
    +
    +
    +
    +
    +
    +
    invitationobject
    +
    +
    + The invitation for the user or email if the action + is member_invited. +
    +
    +
    +
    +
    +
    +
    membershipobject
    +
    +
    + The membership between the user and the + organization. Not present when the action is + member_invited. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "member_added", "membership": { "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat", + "state": "active", "role": "member", "organization_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", "user": { + "login": "Hacktocat", "id": 5, "node_id": "MDQ6VXNlcjU=", + "avatar_url": "https://octocoders.github.io/avatars/u/5?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Hacktocat", "html_url": + "https://octocoders.github.io/Hacktocat", "followers_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/received_events", + "type": "User", "site_admin": false } }, "organization": { + "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + package +

    +
    +
    + Activity related to GitHub Packages. The type of activity is + specified in the action property of the payload + object. For more information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be + published or updated. +
    +
    +
    +
    +
    +
    +
    packageobject
    +
    +
    Information about the package.
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "package": { "id": 10696, "name": + "hello-world-npm", "namespace": "Codertocat/hello-world-npm", + "description": null, "ecosystem": "docker", "package_type": "npm", + "html_url": + "https://github.com/Codertocat/hello-world-npm/packages/10696", + "created_at": "2019-05-09T23:28:29Z", "updated_at": + "2019-05-09T23:28:29Z", "owner": { "login": "Codertocat", "id": + 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "package_version": { "id": 24147, + "version": "1.0.0", "summary": "A simple npm package to + demonstrate GitHub Packages", "name": + "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "description": "", "body": "# hello-world-npm\n\nThis is a simple + npm package that demonstrates the [Github + Packages](https://github.com/features/package).\n\n## Installation + \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = + require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n", + "body_html": "<h1>hello-world-npm</h1>\n<p>This + is a simple npm package that demonstrates the <a + href=\"https://github.com/features/package\">Github Package + Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ + npm + install</code></p>\n<h2>Usage</h2>\n<pre><code>const + myPackage = + require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>", + "release": { "url": + "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286", + "html_url": + "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0", + "id": 17264286, "tag_name": "1.0.0", "target_commitish": "master", + "name": "1.0.0", "draft": false, "author": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "prerelease": false, "created_at": + "2019-05-09T23:24:40Z", "published_at": "2019-05-09T23:26:59Z" }, + "manifest": + "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A + simple npm package to demonstrate GitHub Package + Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo + \\\"Error: no test specified\\\" \\u0026\\u0026 exit + 1\"},\"version\":\"1.0.0\"}", "html_url": + "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0", + "tag_name": "1.0.0", "target_commitish": "master", "target_oid": + "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", "draft": false, + "prerelease": false, "created_at": "2019-05-09T23:28:29Z", + "updated_at": "2019-05-09T23:28:30Z", "metadata": [], + "docker_metadata": [], "package_files": [ { "download_url": + "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream", + "id": 92167, "name": "hello-world-npm-1.0.0-npm.tgz", "sha256": + "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8", + "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb", "md5": + "56ebbd5a5a03367f62d0c732bafd3c66", "content_type": + "application/octet-stream", "state": "uploaded", "size": 654, + "created_at": "2019-05-09T23:28:30Z", "updated_at": + "2019-05-09T23:28:30Z" } ], "author": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "source_url": + "ghcr.io/Codertocat/hello-world-npm/image-1:v1", + "installation_command": "npm install @Codertocat/@1.0.0" }, + "registry": { "about_url": + "https://help.github.com/about-github-packages", "name": "GitHub + npm registry", "type": "npm", "url": + "https://npm.pkg.github.com/@Codertocat", "vendor": "GitHub Inc" } + }, "repository": { "id": 185882436, "node_id": + "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=", "name": "hello-world-npm", + "full_name": "Codertocat/hello-world-npm", "private": true, + "owner": { "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "html_url": + "https://github.com/Codertocat/hello-world-npm", "description": + null, "fork": false, "url": + "https://api.github.com/repos/Codertocat/hello-world-npm", + "forks_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/deployments", + "created_at": "2019-05-09T22:53:26Z", "updated_at": + "2019-05-09T23:24:42Z", "pushed_at": "2019-05-09T23:27:00Z", + "git_url": "git://github.com/Codertocat/hello-world-npm.git", + "ssh_url": "git@github.com:Codertocat/hello-world-npm.git", + "clone_url": "https://github.com/Codertocat/hello-world-npm.git", + "svn_url": "https://github.com/Codertocat/hello-world-npm", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + page_build +

    +
    +
    + Represents an attempted build of a GitHub Pages site, whether + successful or not. A push to a GitHub Pages enabled branch (gh-pages + for project pages, the default branch for user and organization + pages) triggers this event. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Pages permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    idinteger
    +
    +
    The unique identifier of the page build.
    +
    +
    +
    +
    +
    +
    buildobject
    +
    +
    + The + List GitHub Pages builds + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "id": 7, "build": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7", + "status": "built", "error": { "message": null }, "pusher": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "commit": + "3648135c2986115284ae152d90459473b15fd19c", "duration": 6917, + "created_at": "2019-05-15T19:38:15Z", "updated_at": + "2019-05-15T19:38:22Z" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + ping +

    +
    +
    + When you create a new webhook, we'll send you a simple + ping event to let you know you've set up the webhook + correctly. This event isn't stored so it isn't retrievable via the organizationEvents API - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "key": {
-    "id": 100,
-    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100",
-    "title": "hey-its-a-deploy-key",
-    "verified": true,
-    "created_at": "2019-04-02T17:37:07Z",
-    "read_only": true
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    + endpoint. +
    +

    Availability

    + +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    zenstring
    +
    +
    Random string of GitHub zen.
    +
    +
    +
    +
    +
    +
    hook_idinteger
    +
    +
    + The ID of the webhook that triggered the ping. +
    +
    +
    +
    +
    +
    +
    hookobject
    +
    + +
    +
    +
    +
    +
    +
    hook[app_id]integer
    +
    +
    + When you register a new GitHub App, GitHub + Enterprise Server sends a ping event to the + webhook URL you specified during + registration. The event contains the + app_id, which is required for + authenticating + an app. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "zen": "Non-blocking is better than blocking.", "hook_id": 30, + "hook": { "type": "Repository", "id": 30, "name": "web", "active": + true, "events": [ "*" ], "config": { "content_type": "json", + "url": "https://smee.io/YEbF2t8kjvPAn7Ck", "insecure_ssl": "0" }, + "updated_at": "2019-05-15T19:38:17Z", "created_at": + "2019-05-15T19:38:17Z", "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30", + "test_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test", + "ping_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings", + "last_response": { "code": null, "status": "unused", "message": + null } }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    + -

    - - deployment -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployment" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deploymentobject - The - deployment. -
    repositoryobject - The - repository +
    +

    +

    organizationobject - Webhook payloads contain the - organizationproject + +
    +
    + Activity related to project boards. The type of activity is + specified in the action property of the payload + object. For more information, see the "projects" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:20Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed on the project. Can be + one of created, edited, + closed, reopened, or + deleted. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the project if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from]string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    projectobject
    +
    +
    + The + project + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "created", "project": { "owner_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "url": "https://octocoders.github.io/api/v3/projects/6", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/projects/1", + "columns_url": + "https://octocoders.github.io/api/v3/projects/6/columns", "id": 6, + "node_id": "MDc6UHJvamVjdDY=", "name": "Space 2.0", "body": + "Project tasks for a trip to Space", "number": 1, "state": "open", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:38:27Z" }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - deployment_status -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deployment_statusobject - The - deployment status. -
    deployment_status["state"]string - The new state. Can be pending, success, - failure, or error. -
    deployment_status["target_url"]stringThe optional link added to the status.
    deployment_status["description"]string - The optional human-readable description added to the status. -
    deploymentobject - The - deployment +
    +

    +

    repositoryobject - The - repositoryproject_card + +
    +
    + Activity related to cards in a project board. The type of activity + is specified in the action property of the payload + object. For more information, see the "project cards" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed on the project card. Can be + created, edited, + moved, converted, or + deleted. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the project card if the action was + edited or converted. +
    +
    +
    +
    +
    +
    +
    + changes[note][from]string +
    +
    +
    + The previous version of the note if the action was + edited or converted. +
    +
    +
    +
    +
    +
    +
    after_idinteger
    +
    +
    + The id of the card that this card now follows if the + action was "moved". Will be null if it + is the first card in a column. +
    +
    +
    +
    +
    +
    +
    project_cardobject
    +
    +
    + The + project card + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "project_card": { "url": + "https://octocoders.github.io/api/v3/projects/columns/cards/8", + "project_url": "https://octocoders.github.io/api/v3/projects/6", + "column_url": + "https://octocoders.github.io/api/v3/projects/columns/8", + "column_id": 8, "id": 8, "node_id": "MDExOlByb2plY3RDYXJkOA==", + "note": "Work that can be completed in one hour or less.", + "archived": false, "creator": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:39:01Z", "updated_at": "2019-05-15T19:39:01Z" }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    + + +
    +
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "deployment_status": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2",
-    "id": 2,
-    "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy",
-    "state": "success",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "description": "",
-    "environment": "production",
-    "target_url": "",
-    "created_at": "2019-05-15T19:38:21Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "deployment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - enterprise -

    -

    - A site or repository administrator enables or disables anonymous Git - read access. See "Allowing admins to enable anonymous Git read access to public - repositories" for more details. This event is not available in the Events API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be - anonymous_access_enabled or - anonymous_access_disabled. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "anonymous_access_enabled",
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - fork -

    -

    - A user forks a repository. For more information, see the "forks" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    forkeeobject - The created - repository - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "forkee": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "public": true
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - github_app_authorization -

    -

    - When someone revokes their authorization of a GitHub App, this event - occurs. A GitHub App receives this webhook by default and cannot - unsubscribe from this event. -

    -

    - Anyone 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 user-to-server requests, which require GitHub App - authorization, see "Identifying and authorizing users for GitHub Apps." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be revoked.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "revoked",
-  "sender": {
-    "login": "octocat",
-    "id": 1,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - gollum -

    -

    - A wiki page is created or updated. For more information, see "About wikis." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    pagesarrayThe pages that were updated.
    pages[][page_name]stringThe name of the page.
    pages[][title]stringThe current page title.
    pages[][action]string - The action that was performed on the page. Can be - created or edited. -
    pages[][sha]stringThe latest commit SHA of the page.
    pages[][html_url]stringPoints to the HTML wiki page.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "pages": [
-    {
-      "page_name": "Home",
-      "title": "Home",
-      "summary": null,
-      "action": "edited",
-      "sha": "4bbb6df16cb5ce1818602bf634e94ebdac7ae385",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home"
-    }
-  ],
-  "repository": {
-    "id": 122,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-10-04T18:29:19Z",
-    "updated_at": "2018-10-04T18:29:21Z",
-    "pushed_at": "2018-10-04T18:29:59Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "rachmari",
-    "id": 3,
-    "node_id": "MDQ6VXNlcjM=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/3?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/rachmari",
-    "html_url": "https://octocoders.github.io/rachmari",
-    "followers_url": "https://octocoders.github.io/api/v3/users/rachmari/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/rachmari/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/rachmari/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/rachmari/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/rachmari/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - installation -

    -

    - Activity related to a GitHub App installation. The type of activity is - specified in the action property of the payload object. For - more information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • created - Someone installs a GitHub App.
      • -
    • deleted - Someone uninstalls a GitHub App
      • -
    • - suspend - Someone suspends a GitHub App - installation. -
      • -
    • - unsuspend - Someone unsuspends a GitHub App - installation. -
      • -
    • - new_permissions_accepted - Someone accepts new - permissions for a GitHub App installation. When a GitHub App - owner requests new permissions, the person who installed the - GitHub App must accept the new permissions request. -
      • -
    -
    repositoriesarray - An array of repository objects that the installation can access. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-      "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-      "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-      "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-      "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-      "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "checks": "write",
-      "contents": "write",
-      "deployments": "write",
-      "issues": "write",
-      "pages": "write",
-      "pull_requests": "write",
-      "repository_hooks": "write",
-      "repository_projects": "write",
-      "statuses": "write",
-      "repository_pre_receive_hooks": "write",
-      "metadata": "read",
-      "vulnerability_alerts": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": "2019-05-15T19:37:38.000Z",
-    "updated_at": "2019-05-15T19:37:38.000Z",
-    "single_file_name": null
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-    "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-    "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-    "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-    "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - installation_repositories -

    -

    - Activity related to repositories being added to a GitHub App - installation. The type of activity is specified in the - action property of the payload object. For more - information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be either added or - removed. -
    repository_selectionstring - The choice of repositories the installation is on. Can be either - selected or all. -
    repositories_addedarray - An array of repository objects, which were added to the - installation. -
    repositories_removedarray - An array of repository objects, which were removed from the - installation. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "https://octocoders.github.io/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "https://octocoders.github.io/api/v3/installation/repositories",
-    "html_url": "https://octocoders.github.io/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "repository_pre_receive_hooks": "write",
-      "statuses": "write",
-      "repository_projects": "write",
-      "repository_hooks": "write",
-      "pull_requests": "write",
-      "pages": "write",
-      "issues": "write",
-      "deployments": "write",
-      "contents": "write",
-      "checks": "write",
-      "vulnerability_alerts": "read",
-      "metadata": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": 1557949058,
-    "updated_at": 1557949058,
-    "single_file_name": null
-  },
-  "repository_selection": "selected",
-  "repositories_added": [
-    {
-      "id": 119,
-      "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=",
-      "name": "Space",
-      "full_name": "Codertocat/Space",
-      "private": false
-    }
-  ],
-  "repositories_removed": [],
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - issue_comment -

    -

    - Activity related to an issue or pull request comment. The type of - activity is specified in the action property of the payload - object. For more information, see the "issue comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    issueobject - The - issue - the comment belongs to. -
    commentobject - The - comment - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "id": 2,
-    "node_id": "MDEyOklzc3VlQ29tbWVudDI=",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:37:55Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "author_association": "OWNER",
-    "body": "You are totally right! I'll get this fixed right away."
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - issues -

    -

    - Activity related to an issue. The type of activity is specified in the - action property of the payload object. For more - information, see the "issues" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of opened, - edited, deleted, pinned, - unpinned, closed, reopened, - assigned, unassigned, - labeled, unlabeled, locked, - unlocked, transferred, - milestoned, or demilestoned. -
    issueobject - The - issue - itself. -
    changesobject - The changes to the issue if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    assigneeobject - The optional user who was assigned or unassigned from the issue. -
    labelobject - The optional label that was added or removed from the issue. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example when someone edits an issue -

    -
    - 
    {
-  "action": "edited",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:54Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "changes": {},
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - label -

    -

    - Activity related to a label. The type of activity is specified in the - action property of the payload object. For more - information, see the "labels" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be created, - edited, or deleted. -
    labelobjectThe label that was added.
    changesobject - The changes to the label if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[color][from]string - The previous version of the color if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "label": {
-    "id": 965,
-    "node_id": "MDU6TGFiZWw5NjU=",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix",
-    "name": ":bug: Bugfix",
-    "color": "cceeaa",
-    "default": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - member -

    -

    - Activity related to repository collaborators. The type of activity is - specified in the action property of the payload object. For - more information, see the "collaborators" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - added - A user accepts an invitation to a - repository. -
      • -
    • - removed - A user is removed as a collaborator in - a repository. -
      • -
    • - edited - A user's collaborator permissions have - changed. -
      • -
    -
    memberobject - The - user - that was added. -
    changesobject - The changes to the collaborator permissions if the action was - edited. -
    changes[old_permission][from]string - The previous permissions of the collaborator if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "member": {
-    "login": "Hacktocat",
-    "id": 5,
-    "node_id": "MDQ6VXNlcjU=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-    "html_url": "https://octocoders.github.io/Hacktocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - membership -

    -

    - Activity related to team membership. The type of activity is specified - in the action property of the payload object. For more - information, see the "team members" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be added or - removed. -
    scopestring - The scope of the membership. Currently, can only be - team. -
    memberobject - The - user - that was added or removed. -
    teamobject - The - team - for the membership. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "removed",
-  "scope": "team",
-  "member": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  }
-}
-
    -
    -

    - - meta -

    -

    - The webhook this event is configured on was deleted. This event will - only listen for changes to the particular hook the event is installed - on. Therefore, it must be selected for each hook that you'd like to - receive meta events for. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be deleted.
    hook_idintegerThe id of the modified webhook.
    hookobject - The modified webhook. This will contain different keys based on - the type of webhook it is: repository, organization, business, - app, or GitHub Marketplace. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "hook_id": 101047067,
-  "hook": {
-    "type": "Repository",
-    "id": 101047067,
-    "name": "web",
-    "active": true,
-    "events": [
-      "meta"
-    ],
-    "config": {
-      "content_type": "json",
-      "insecure_ssl": "0",
-      "url": "http://example.com/hook"
-    },
-    "updated_at": "2019-04-10T03:57:12Z",
-    "created_at": "2019-04-10T03:57:12Z"
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - milestone -

    -

    - Activity related to milestones. The type of activity is specified in the - action property of the payload object. For more - information, see the "milestones" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - closed, opened (a closed milestone is - re-opened), edited, or deleted. -
    milestoneobjectThe milestone itself.
    changesobject - The changes to the milestone if the action was - edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[due_on][from]string - The previous version of the due date if the action was - edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "milestone": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-    "id": 2,
-    "node_id": "MDk6TWlsZXN0b25lMg==",
-    "number": 1,
-    "title": "v1.0",
-    "description": "Add new space flight simulator",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "open_issues": 0,
-    "closed_issues": 0,
-    "state": "open",
-    "created_at": "2019-05-15T19:37:52Z",
-    "updated_at": "2019-05-15T19:37:52Z",
-    "due_on": "2019-05-23T00:00:00Z",
-    "closed_at": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - organization -

    -

    - Activity related to an organization and its members. The type of - activity is specified in the action property of the payload - object. For more information, see the "organizations" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: - created, deleted, renamed, - member_added, member_removed, or - member_invited. -
    invitationobject - The invitation for the user or email if the action is - member_invited. -
    membershipobject - The membership between the user and the organization. Not present - when the action is member_invited. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "member_added",
-  "membership": {
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat",
-    "state": "active",
-    "role": "member",
-    "organization_url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "user": {
-      "login": "Hacktocat",
-      "id": 5,
-      "node_id": "MDQ6VXNlcjU=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-      "html_url": "https://octocoders.github.io/Hacktocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-      "type": "User",
-      "site_admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - package -

    -

    - Activity related to GitHub Packages. The type of activity is specified - in the action property of the payload object. For more - information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be published or - updated. -
    packageobjectInformation about the package.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "package": {
-    "id": 10696,
-    "name": "hello-world-npm",
-    "namespace": "Codertocat/hello-world-npm",
-    "description": null,
-    "ecosystem": "docker",
-    "package_type": "npm",
-    "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696",
-    "created_at": "2019-05-09T23:28:29Z",
-    "updated_at": "2019-05-09T23:28:29Z",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "package_version": {
-      "id": 24147,
-      "version": "1.0.0",
-      "summary": "A simple npm package to demonstrate GitHub Packages",
-      "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498",
-      "description": "",
-      "body": "# hello-world-npm\n\nThis is a simple npm package that demonstrates the [Github Packages](https://github.com/features/package).\n\n## Installation \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n",
-      "body_html": "<h1>hello-world-npm</h1>\n<p>This is a simple npm package that demonstrates the <a href=\"https://github.com/features/package\">Github Package Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ npm install</code></p>\n<h2>Usage</h2>\n<pre><code>const myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>",
-      "release": {
-        "url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286",
-        "html_url": "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0",
-        "id": 17264286,
-        "tag_name": "1.0.0",
-        "target_commitish": "master",
-        "name": "1.0.0",
-        "draft": false,
-        "author": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "prerelease": false,
-        "created_at": "2019-05-09T23:24:40Z",
-        "published_at": "2019-05-09T23:26:59Z"
-      },
-      "manifest": "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A simple npm package to demonstrate GitHub Package Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo \\\"Error: no test specified\\\" \\u0026\\u0026 exit 1\"},\"version\":\"1.0.0\"}",
-      "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0",
-      "tag_name": "1.0.0",
-      "target_commitish": "master",
-      "target_oid": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b",
-      "draft": false,
-      "prerelease": false,
-      "created_at": "2019-05-09T23:28:29Z",
-      "updated_at": "2019-05-09T23:28:30Z",
-      "metadata": [],
-      "docker_metadata": [],
-      "package_files": [
-        {
-          "download_url": "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream",
-          "id": 92167,
-          "name": "hello-world-npm-1.0.0-npm.tgz",
-          "sha256": "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8",
-          "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb",
-          "md5": "56ebbd5a5a03367f62d0c732bafd3c66",
-          "content_type": "application/octet-stream",
-          "state": "uploaded",
-          "size": 654,
-          "created_at": "2019-05-09T23:28:30Z",
-          "updated_at": "2019-05-09T23:28:30Z"
-        }
-      ],
-      "author": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "source_url": "ghcr.io/Codertocat/hello-world-npm/image-1:v1",
-      "installation_command": "npm install @Codertocat/@1.0.0"
-    },
-    "registry": {
-      "about_url": "https://help.github.com/about-github-packages",
-      "name": "GitHub npm registry",
-      "type": "npm",
-      "url": "https://npm.pkg.github.com/@Codertocat",
-      "vendor": "GitHub Inc"
-    }
-  },
-  "repository": {
-    "id": 185882436,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=",
-    "name": "hello-world-npm",
-    "full_name": "Codertocat/hello-world-npm",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/hello-world-npm",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world-npm",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments",
-    "created_at": "2019-05-09T22:53:26Z",
-    "updated_at": "2019-05-09T23:24:42Z",
-    "pushed_at": "2019-05-09T23:27:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world-npm.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world-npm.git",
-    "clone_url": "https://github.com/Codertocat/hello-world-npm.git",
-    "svn_url": "https://github.com/Codertocat/hello-world-npm",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - page_build -

    -

    - Represents an attempted build of a GitHub Pages site, whether successful - or not. A push to a GitHub Pages enabled branch (gh-pages - for project pages, the default branch for user and organization pages) - triggers this event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    idintegerThe unique identifier of the page build.
    buildobject - The - List GitHub Pages builds - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 7,
-  "build": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7",
-    "status": "built",
-    "error": {
-      "message": null
-    },
-    "pusher": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "commit": "3648135c2986115284ae152d90459473b15fd19c",
-    "duration": 6917,
-    "created_at": "2019-05-15T19:38:15Z",
-    "updated_at": "2019-05-15T19:38:22Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - ping -

    -

    - When you create a new webhook, we'll send you a simple - ping event to let you know you've set up the webhook - correctly. This event isn't stored so it isn't retrievable via the - Events API - endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    zenstringRandom string of GitHub zen.
    hook_idintegerThe ID of the webhook that triggered the ping.
    hookobject - The - webhook configuration. -
    hook[app_id]integer - When you register a new GitHub App, GitHub Enterprise Server sends - a ping event to the webhook URL you specified - during registration. The event contains the app_id, - which is required for - authenticating - an app. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "zen": "Non-blocking is better than blocking.",
-  "hook_id": 30,
-  "hook": {
-    "type": "Repository",
-    "id": 30,
-    "name": "web",
-    "active": true,
-    "events": [
-      "*"
-    ],
-    "config": {
-      "content_type": "json",
-      "url": "https://smee.io/YEbF2t8kjvPAn7Ck",
-      "insecure_ssl": "0"
-    },
-    "updated_at": "2019-05-15T19:38:17Z",
-    "created_at": "2019-05-15T19:38:17Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30",
-    "test_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test",
-    "ping_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings",
-    "last_response": {
-      "code": null,
-      "status": "unused",
-      "message": null
-    }
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - project -

    -

    - Activity related to project boards. The type of activity is specified in - the action property of the payload object. For more - information, see the "projects" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project. Can be one of - created, edited, closed, - reopened, or deleted. -
    changesobject - The changes to the project if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    projectobject - The - project - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project": {
-    "owner_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "url": "https://octocoders.github.io/api/v3/projects/6",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/projects/1",
-    "columns_url": "https://octocoders.github.io/api/v3/projects/6/columns",
-    "id": 6,
-    "node_id": "MDc6UHJvamVjdDY=",
-    "name": "Space 2.0",
-    "body": "Project tasks for a trip to Space",
-    "number": 1,
-    "state": "open",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:38:27Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - project_card -

    -

    - Activity related to cards in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project cards" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed on the project card. Can be - created, edited, moved, - converted, or deleted. -
    changesobject - The changes to the project card if the action was - edited or converted. -
    changes[note][from]string - The previous version of the note if the action was - edited or converted. -
    after_idinteger - The id of the card that this card now follows if the action was - "moved". Will be null if it is the first card in a - column. -
    project_cardobject - The - project card - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_card": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/cards/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "column_url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "column_id": 8,
-    "id": 8,
-    "node_id": "MDExOlByb2plY3RDYXJkOA==",
-    "note": "Work that can be completed in one hour or less.",
-    "archived": false,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - project_column -

    -

    - Activity related to columns in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project columns" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project column. Can be one of - created, edited, moved or - deleted. -
    changesobject - The changes to the project column if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    after_idinteger - The id of the column that this column now follows if the action - was "moved". Will be null if it is the first column - in a project. -
    project_columnobject - The - project column - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_column": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "cards_url": "https://octocoders.github.io/api/v3/projects/columns/8/cards",
-    "id": 8,
-    "node_id": "MDEzOlByb2plY3RDb2x1bW44",
-    "name": "Small bugfixes",
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - public -

    -

    - When a private repository is made public. Without a doubt: the best - GitHub Enterprise Server event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request -

    -

    - Activity related to pull requests. The type of activity is specified in - the action property of the payload object. For more - information, see the "pull requests" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • assigned
      • -
    • auto_merge_disabled
      • -
    • auto_merge_enabled
      • -
    • - closed: If the action is closed and - the merged key is false, the pull - request was closed with unmerged commits. If the action is - closed and the merged key is - true, the pull request was merged. -
      • -
    • converted_to_draft
      • -
    • edited
      • -
    • labeled
      • -
    • locked
      • -
    • opened
      • -
    • ready_for_review
      • -
    • reopened
      • -
    • review_request_removed
      • -
    • review_requested
      • -
    • - synchronize: Triggered when a pull request's head - branch is updated. For example, when the head branch is - updated from the base branch, when new commits are pushed to - the head branch, or when the base branch is changed. -
      • -
    • unassigned
      • -
    • unlabeled
      • -
    • unlocked
      • -
    -
    numberintegerThe pull request number.
    changesobject - The changes to the comment if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -

    - Deliveries for review_requested and - review_request_removed events will have an additional field - called requested_reviewer. -

    -
    - 
    {
-  "action": "opened",
-  "number": 2,
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:02Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": null,
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER",
-    "draft": false,
-    "merged": false,
-    "mergeable": null,
-    "rebaseable": null,
-    "mergeable_state": "unknown",
-    "merged_by": null,
-    "comments": 0,
-    "review_comments": 0,
-    "maintainer_can_modify": false,
-    "commits": 1,
-    "additions": 1,
-    "deletions": 1,
-    "changed_files": 1
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review -

    -

    - Activity related to pull request reviews. The type of activity is - specified in the action property of the payload object. For - more information, see the "pull request reviews" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - submitted - A pull request review is submitted - into a non-pending state. -
      • -
    • - edited - The body of a review has been edited. -
      • -
    • dismissed - A review has been dismissed.
      • -
    -
    pull_requestobject - The - pull request - the review pertains to. -
    reviewobjectThe review that was affected.
    changes[body][from]string - The previous version of the body if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "submitted",
-  "review": {
-    "id": 2,
-    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": null,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "submitted_at": "2019-05-15T19:38:08Z",
-    "state": "commented",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review_comment -

    -

    - Activity related to pull request review comments in the pull request's - unified diff. The type of activity is specified in the - action property of the payload object. For more - information, see the "pull request review comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request - the comment belongs to. -
    commentobject - The - comment - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2",
-    "pull_request_review_id": 2,
-    "id": 2,
-    "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=",
-    "diff_hunk": "@@ -1 +1 @@\n-# Hello-World",
-    "path": "README.md",
-    "position": 1,
-    "original_position": 1,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "original_commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "Maybe you should use more emoji on this line.",
-    "created_at": "2019-05-15T19:38:07Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review_thread -

    -

    - Activity related to a comment thread on a pull request being marked as - resolved or unresolved. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - resolved - A comment thread on a pull request was - marked as resolved. -
      • -
    • - unresolved - A previously resolved comment thread - on a pull request was marked as unresolved. -
      • -
    -
    pull_requestobject - The - pull request - the thread pertains to. -
    threadobjectThe thread that was affected.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "resolved",
-  "pull_request": {
-    "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-    "id": 873298238,
-    "node_id": "PR_kwDOEL39TM40DXk-",
-    "html_url": "https://github.com/octo-org/octo-repo/pull/118",
-    "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff",
-    "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch",
-    "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118",
-    "number": 118,
-    "state": "open",
-    "locked": false,
-    "title": "Create issue-comment",
-    "user": {
-      "login": "octocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "body": "Issue comment test",
-    "created_at": "2022-03-07T16:14:34Z",
-    "updated_at": "2022-03-21T09:21:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "draft": false,
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits",
-    "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments",
-    "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-    "head": {
-      "label": "octo-org:issue-comment",
-      "ref": "issue-comment",
-      "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "octo-org:master",
-      "ref": "master",
-      "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-      },
-      "html": {
-        "href": "https://github.com/octo-org/octo-repo/pull/118"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf"
-      }
-    },
-    "author_association": "CONTRIBUTOR",
-    "auto_merge": null,
-    "active_lock_reason": null
-  },
-  "thread": {
-    "node_id": "PRRT_kwDOEL39TM4w7XDQ",
-    "comments": [
-      {
-        "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280",
-        "pull_request_review_id": 901921390,
-        "id": 820867280,
-        "node_id": "PRRC_kwDOEL39TM4w7XDQ",
-        "diff_hunk": "@@ -0,0 +1 @@\n+issue comment",
-        "path": "issue-comment",
-        "position": 1,
-        "original_position": 1,
-        "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "user": {
-          "login": "jide2020",
-          "id": 64502150,
-          "node_id": "MDQ6VXNlcjY0NTAyMTUw",
-          "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/jide2020",
-          "html_url": "https://github.com/jide2020",
-          "followers_url": "https://api.github.com/users/jide2020/followers",
-          "following_url": "https://api.github.com/users/jide2020/following{/other_user}",
-          "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions",
-          "organizations_url": "https://api.github.com/users/jide2020/orgs",
-          "repos_url": "https://api.github.com/users/jide2020/repos",
-          "events_url": "https://api.github.com/users/jide2020/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/jide2020/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "body": "sup",
-        "created_at": "2022-03-07T16:16:48Z",
-        "updated_at": "2022-03-07T16:16:58Z",
-        "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280",
-        "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-        "author_association": "COLLABORATOR",
-        "_links": {
-          "self": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280"
-          },
-          "html": {
-            "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280"
-          },
-          "pull_request": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-          }
-        },
-        "reactions": {
-          "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions",
-          "total_count": 0,
-          "+1": 0,
-          "-1": 0,
-          "laugh": 0,
-          "hooray": 0,
-          "confused": 0,
-          "heart": 0,
-          "rocket": 0,
-          "eyes": 0
-        },
-        "start_line": null,
-        "original_start_line": null,
-        "start_side": null,
-        "line": 1,
-        "original_line": 1,
-        "side": "RIGHT"
-      }
-    ]
-  },
-  "repository": {
-    "id": 280886604,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 67584941,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-      "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "Change description",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2020-07-19T14:48:35Z",
-    "updated_at": "2022-03-11T11:56:22Z",
-    "pushed_at": "2022-04-01T09:37:36Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 646,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 60,
-    "license": null,
-    "allow_forking": false,
-    "is_template": false,
-    "topics": [
-      "hey",
-      "topic"
-    ],
-    "visibility": "private",
-    "forks": 0,
-    "open_issues": 60,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 67584941,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - push -

    -

    One or more commits are pushed to a repository branch or tag.

    -
    -

    - Note: You will not receive a webhook for this event - when you push more than three tags at once. -

    -
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The full - git ref - that was pushed. Example: refs/heads/main or - refs/tags/v3.14.1. -
    beforestring - The SHA of the most recent commit on ref before the - push. -
    afterstring - The SHA of the most recent commit on ref after the - push. -
    createdbooleanWhether this push created the ref.
    deletedbooleanWhether this push deleted the ref.
    forcedbooleanWhether this push was a force push of the ref.
    head_commitobject - For pushes where after is or points to a commit - object, an expanded representation of that commit. For pushes - where after refers to an annotated tag object, an - expanded representation of the commit pointed to by the annotated - tag. -
    comparestring - 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. -
    commitsarray - 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.) -
    commits[][id]stringThe SHA of the commit.
    commits[][timestamp]stringThe ISO 8601 timestamp of the commit.
    commits[][message]stringThe commit message.
    commits[][author]objectThe git author of the commit.
    commits[][author][name]stringThe git author's name.
    commits[][author][email]stringThe git author's email address.
    commits[][url]urlURL that points to the commit API resource.
    commits[][distinct]boolean - Whether this commit is distinct from any that have been pushed - before. -
    commits[][added]array - An array of files added in the commit. For extremely large commits - where GitHub Enterprise Server is unable to calculate this list in - a timely manner, this may be empty even if files were added. -
    commits[][modified]array - An array of files modified by the commit. For extremely large - commits where GitHub Enterprise Server is unable to calculate this - list in a timely manner, this may be empty even if files were - modified. -
    commits[][removed]array - An array of files removed in the commit. For extremely large - commits where GitHub Enterprise Server is unable to calculate this - list in a timely manner, this may be empty even if files were - removed. -
    pusherobjectThe user who pushed the commits.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "refs/tags/simple-tag",
-  "before": "0000000000000000000000000000000000000000",
-  "after": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-  "created": true,
-  "deleted": false,
-  "forced": false,
-  "base_ref": null,
-  "compare": "https://octocoders.github.io/Codertocat/Hello-World/compare/simple-tag",
-  "commits": [],
-  "head_commit": {
-    "id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "tree_id": "4b825dc642cb6eb9a060e54bf8d69288fbee4904",
-    "distinct": true,
-    "message": "Adding a .gitignore file",
-    "timestamp": "2019-05-15T15:20:41Z",
-    "url": "https://octocoders.github.io/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "author": {
-      "name": "Codertocat",
-      "email": "Codertocat@octocoders.github.io",
-      "username": "Codertocat"
-    },
-    "committer": {
-      "name": "Codertocat",
-      "email": "Codertocat@octocoders.github.io",
-      "username": "Codertocat"
-    },
-    "added": [
-      ".gitignore"
-    ],
-    "removed": [],
-    "modified": []
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "name": "Codertocat",
-      "email": "Codertocat@octocoders.github.io",
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": 1557949027,
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": 1557949103,
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master",
-    "stargazers": 0,
-    "master_branch": "master"
-  },
-  "pusher": {
-    "name": "Codertocat",
-    "email": "Codertocat@octocoders.github.io"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - release -

    -

    - Activity related to a release. The type of activity is specified in the - action property of the payload object. For more - information, see the "releases" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - published: a release, pre-release, or draft of a - release is published -
      • -
    • - unpublished: a release or pre-release is deleted -
      • -
    • - created: a draft is saved, or a release or - pre-release is published without previously being saved as a - draft -
      • -
    • - edited: a release, pre-release, or draft release - is edited -
      • -
    • - deleted: a release, pre-release, or draft release - is deleted -
      • -
    • prereleased: a pre-release is created
      • -
    • - released: a release is published, or a - pre-release is changed to a release -
      • -
    -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    releaseobject - The - release - object. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "release": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2",
-    "assets_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets",
-    "upload_url": "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1",
-    "id": 2,
-    "node_id": "MDc6UmVsZWFzZTI=",
-    "tag_name": "0.0.1",
-    "target_commitish": "master",
-    "name": null,
-    "draft": false,
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "prerelease": false,
-    "created_at": "2019-05-15T19:37:08Z",
-    "published_at": "2019-05-15T19:38:20Z",
-    "assets": [],
-    "tarball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1",
-    "zipball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1",
-    "body": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - repository_dispatch -

    -

    - This event occurs when a GitHub App sends a POST request to - the "Create a repository dispatch event" endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "on-demand-test",
-  "branch": "master",
-  "client_payload": {
-    "unit": false,
-    "integration": true
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2018-10-10T15:58:51Z",
-    "pushed_at": "2018-10-10T15:58:47Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 59,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 23,
-    "license": null,
-    "forks": 1,
-    "open_issues": 23,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 375706,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2"
-  }
-}
-
    -
    -

    - - repository -

    -

    - Activity related to a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "repositories" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of: -
      -
    • created - A repository is created.
      • -
    • deleted - A repository is deleted.
      • -
    • archived - A repository is archived.
      • -
    • unarchived - A repository is unarchived.
      • -
    • - anonymous_access_enabled - A repository is - enabled for anonymous Git access, anonymous_access_disabled - A repository is - disabled for anonymous Git access -
      • -
    • - edited - A repository's information is edited. -
      • -
    • renamed - A repository is renamed.
      • -
    • transferred - A repository is transferred.
      • -
    • publicized - A repository is made public.
      • -
    • privatized - A repository is made private.
      • -
    -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "publicized",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - secret_scanning_alert -

    -

    - Activity related to secret scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see the "secret scanning API." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be either - created, resolved, or - reopened. -
    alertobjectThe secret scanning alert involved in the event.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is resolved or - reopened, the sender object will be the - user that triggered the event. The sender object is - empty for all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 191,
-    "secret_type": "adafruit_io_key",
-    "resolution": null,
-    "resolved_by": null,
-    "resolved_at": null
-  },
-  "repository": {
-    "id": 257423561,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 30846345,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2020-04-20T22:59:11Z",
-    "updated_at": "2020-11-24T01:37:33Z",
-    "pushed_at": "2020-11-24T01:37:31Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 1156,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": false,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 3,
-    "license": null,
-    "forks": 0,
-    "open_issues": 3,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Codertocat",
-    "id": 30846345,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-    "url": "https://api.github.com/orgs/Codertocat",
-    "repos_url": "https://api.github.com/orgs/Codertocat/repos",
-    "events_url": "https://api.github.com/orgs/Codertocat/events",
-    "hooks_url": "https://api.github.com/orgs/Codertocat/hooks",
-    "issues_url": "https://api.github.com/orgs/Codertocat/issues",
-    "members_url": "https://api.github.com/orgs/Codertocat/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Codertocat/public_members{/member}",
-    "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-    "description": "Demos and testing of GitHub security products"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 10136561,
-    "node_id": "MDQ6VXNlcjEwMTM2NTYx",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/10136561?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - security_advisory -

    -

    - Activity related to a security advisory that has been reviewed by - GitHub. A GitHub-reviewed security advisory provides information about - security-related vulnerabilities in software on GitHub. -

    -

    - The security advisory dataset also powers the GitHub Dependabot alerts. - For more information, see "About Dependabot alerts." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. The action can be one of - published, updated, - performed, or withdrawn for all new - events. -
    security_advisoryobject - The details of the security advisory, including summary, - description, and severity. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "security_advisory": {
-    "ghsa_id": "GHSA-rf4j-j272-fj86",
-    "summary": "Moderate severity vulnerability that affects django",
-    "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
-    "severity": "moderate",
-    "identifiers": [
-      {
-        "value": "GHSA-rf4j-j272-fj86",
-        "type": "GHSA"
-      },
-      {
-        "value": "CVE-2018-6188",
-        "type": "CVE"
-      }
-    ],
-    "references": [
-      {
-        "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
-      }
-    ],
-    "published_at": "2018-10-03T21:13:54Z",
-    "updated_at": "2018-10-03T21:13:54Z",
-    "withdrawn_at": null,
-    "vulnerabilities": [
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
-        "first_patched_version": {
-          "identifier": "2.0.2"
-        }
-      },
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
-        "first_patched_version": {
-          "identifier": "1.11.10"
-        }
-      }
-    ]
-  }
-}
-
    -
    -

    - - star -

    -

    - Activity related to a repository being starred. The type of activity is - specified in the action property of the payload object. For - more information, see the "starring" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created or - deleted. -
    starred_atstring - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "starred_at": "2019-05-15T15:20:40Z",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:40Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - status -

    -

    - When the status of a Git commit changes. For more information, see the - "statuses" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    idintegerThe unique identifier of the status.
    shastringThe Commit SHA.
    statestring - The new state. Can be pending, success, - failure, or error. -
    descriptionstring - The optional human-readable description added to the status. -
    target_urlstringThe optional link added to the status.
    branchesarray - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 2,
-  "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-  "name": "Codertocat/Hello-World",
-  "target_url": null,
-  "context": "default",
-  "description": null,
-  "state": "success",
-  "commit": {
-    "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "node_id": "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=",
-    "commit": {
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@octocoders.github.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "committer": {
-        "name": "GitHub Enterprise",
-        "email": "noreply@octocoders.github.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "message": "Initial commit",
-      "tree": {
-        "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4"
-      },
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-      "comment_count": 1,
-      "verification": {
-        "verified": false,
-        "reason": "unsigned",
-        "signature": null,
-        "payload": null
-      }
-    },
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments",
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "committer": null,
-    "parents": []
-  },
-  "branches": [
-    {
-      "name": "master",
-      "commit": {
-        "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a"
-      },
-      "protected": false
-    },
-    {
-      "name": "changes",
-      "commit": {
-        "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1"
-      },
-      "protected": false
-    },
-    {
-      "name": "gh-pages",
-      "commit": {
-        "sha": "3648135c2986115284ae152d90459473b15fd19c",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c"
-      },
-      "protected": false
-    }
-  ],
-  "created_at": "2019-05-15T19:38:21+00:00",
-  "updated_at": "2019-05-15T19:38:21+00:00",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - team -

    -

    - Activity related to an organization's team. The type of activity is - specified in the action property of the payload object. For - more information, see the "teams" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - deleted, edited, - added_to_repository, or - removed_from_repository. -
    teamobjectThe team itself.
    changesobject - The changes to the team if the action was edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[privacy][from]string - The previous version of the team's privacy if the action was - edited. -
    changes[repository][permissions][from][admin]boolean - The previous version of the team member's - admin permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][pull]boolean - The previous version of the team member's - pull permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][push]boolean - The previous version of the team member's - push permission on a repository, if the action was - edited. -
    repositoryobject - The repository that was added or removed from to the team's - purview if the action was added_to_repository, - removed_from_repository, or edited. For - edited actions, repository also contains - the team's new permission levels for the repository. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added_to_repository",
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "permissions": {
-      "pull": true,
-      "push": false,
-      "admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - team_add -

    -

    - When a - repository is added to a team. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    teamobject - The - team - that was modified. Note: Older events may not - include this in the payload. -
    repositoryobject - The - repositoryproject_column + +
    +
    + Activity related to columns in a project board. The type of + activity is specified in the action property of the + payload object. For more information, see the "project columns" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed on the project column. + Can be one of created, + edited, moved or + deleted. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the project column if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from]string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    after_idinteger
    +
    +
    + The id of the column that this column now follows if + the action was "moved". Will be null if + it is the first column in a project. +
    +
    +
    +
    +
    +
    +
    + project_columnobject +
    +
    +
    + The + project column + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "project_column": { "url": + "https://octocoders.github.io/api/v3/projects/columns/8", + "project_url": "https://octocoders.github.io/api/v3/projects/6", + "cards_url": + "https://octocoders.github.io/api/v3/projects/columns/8/cards", + "id": 8, "node_id": "MDEzOlByb2plY3RDb2x1bW44", "name": "Small + bugfixes", "created_at": "2019-05-15T19:39:01Z", "updated_at": + "2019-05-15T19:39:01Z" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + + +
    +
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    + public + +
    +
    + When a private repository is made public. Without a doubt: the + best GitHub Enterprise Server event. +
    +

    Availability

    + +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - user -

    -

    When a user is created or deleted.

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "user": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "action": "created",
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + pull_request +

    +
    +
    + Activity related to pull requests. The type of activity is + specified in the action property of the payload + object. For more information, see the "pull requests" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: +
      +
    • assigned
      • +
    • auto_merge_disabled
      • +
    • auto_merge_enabled
      • +
    • + closed: If the action is + closed and the + merged key is false, + the pull request was closed with unmerged + commits. If the action is + closed and the + merged key is true, + the pull request was merged. +
      • +
    • converted_to_draft
      • +
    • edited
      • +
    • labeled
      • +
    • locked
      • +
    • opened
      • +
    • ready_for_review
      • +
    • reopened
      • +
    • review_request_removed
      • +
    • review_requested
      • +
    • + synchronize: Triggered when a pull + request's head branch is updated. For example, + when the head branch is updated from the base + branch, when new commits are pushed to the head + branch, or when the base branch is changed. +
      • +
    • unassigned
      • +
    • unlabeled
      • +
    • unlocked
      • +
    +
    +
    +
    +
    +
    +
    +
    numberinteger
    +
    +
    The pull request number.
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from]string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    pull_requestobject
    +
    +
    + The + pull request + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +
    -

    - - watch -

    -

    - When someone stars a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "starring" REST API. -

    -

    - The event’s actor is the - user who - starred a repository, and the event’s repository is the - repository - that was starred. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - started. -
    repositoryobject - The - repository +
    organizationobject - Webhook payloads contain the - organizationpull_request_review + +
    +
    + Activity related to pull request reviews. The type of activity is + specified in the action property of the payload + object. For more information, see the "pull request reviews" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + submitted - A pull request review + is submitted into a non-pending state. +
      • +
    • + edited - The body of a review has + been edited. +
      • +
    • + dismissed - A review has been + dismissed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    pull_requestobject
    +
    +
    + The + pull request + the review pertains to. +
    +
    +
    +
    +
    +
    +
    reviewobject
    +
    +
    The review that was affected.
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "submitted", "review": { "id": 2, "node_id": + "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": null, "commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "submitted_at": + "2019-05-15T19:38:08Z", "state": "commented", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2", + "pull_request_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", "_links": { "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2" + }, "pull_request": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + } } }, "pull_request": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2", + "diff_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff", + "patch_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2", + "number": 2, "state": "open", "locked": false, "title": "Update + the README with new information.", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "This is a pretty + simple change that we need to pull into master.", "created_at": + "2019-05-15T19:38:02Z", "updated_at": "2019-05-15T19:38:08Z", + "closed_at": null, "merged_at": null, "merge_commit_sha": + "e67e14475991deeb61cc1999c3bf9db333ac0d5f", "assignee": null, + "assignees": [], "requested_reviewers": [], "requested_teams": [], + "labels": [], "milestone": null, "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1", + "head": { "label": "Codertocat:changes", "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "base": { "label": + "Codertocat:master", "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2" }, + "issue": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2" + }, "comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments" + }, "review_comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments" + }, "review_comment": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}" + }, "commits": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits" + }, "statuses": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1" + } }, "author_association": "OWNER" }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + + +
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "started",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    + pull_request_review_comment + +
    +
    + Activity related to pull request review comments in the pull + request's unified diff. The type of activity is specified in the + action property of the payload object. For more + information, see the "pull request review comments" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed on the comment. Can be + one of created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    pull_requestobject
    +
    +
    + The + pull request + the comment belongs to. +
    +
    +
    +
    +
    +
    +
    commentobject
    +
    +
    + The + comment + itself. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2", + "pull_request_review_id": 2, "id": 2, "node_id": + "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=", "diff_hunk": "@@ -1 +1 + @@\n-# Hello-World", "path": "README.md", "position": 1, + "original_position": 1, "commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "original_commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "Maybe you should + use more emoji on this line.", "created_at": + "2019-05-15T19:38:07Z", "updated_at": "2019-05-15T19:38:08Z", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2", + "pull_request_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2" + }, "pull_request": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + } } }, "pull_request": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2", + "diff_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff", + "patch_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2", + "number": 2, "state": "open", "locked": false, "title": "Update + the README with new information.", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "This is a pretty + simple change that we need to pull into master.", "created_at": + "2019-05-15T19:38:02Z", "updated_at": "2019-05-15T19:38:08Z", + "closed_at": null, "merged_at": null, "merge_commit_sha": + "e67e14475991deeb61cc1999c3bf9db333ac0d5f", "assignee": null, + "assignees": [], "requested_reviewers": [], "requested_teams": [], + "labels": [], "milestone": null, "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1", + "head": { "label": "Codertocat:changes", "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "base": { "label": + "Codertocat:master", "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2" }, + "issue": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2" + }, "comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments" + }, "review_comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments" + }, "review_comment": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}" + }, "commits": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits" + }, "statuses": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1" + } }, "author_association": "OWNER" }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - workflow_dispatch -

    -

    - This event occurs when someone triggers a workflow run on GitHub or - sends a POST request to the "Create a workflow dispatch event" endpoint. For more information, see "Events that trigger workflows." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    inputsobject - Inputs to the workflow. Each key represents the name of the input - while its value represents the value of that input. -
    organizationobject - Webhook payloads contain the - organization +
    +

    +

    refstringThe branch or tag from which the workflow was run.
    repositoryobject - The - repositorypull_request_review_thread + +
    +
    + Activity related to a comment thread on a pull request being + marked as resolved or unresolved. The type of activity is + specified in the action property of the payload + object. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - - - - - - - - -
    senderobjectThe user that triggered the event.
    workflowstring - Relative path to the workflow file which contains the workflow. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "inputs": {
-    "name": "Mona the Octocat"
-  },
-  "organization": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": null,
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "id": 79927191,
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "login": "octo-org",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "url": "https://api.github.com/orgs/octo-org"
-  },
-  "ref": "refs/heads/main",
-  "repository": {
-    "allow_forking": true,
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "created_at": "2021-08-16T21:34:28Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "fork": false,
-    "forks": 1,
-    "forks_count": 1,
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "full_name": "octo-org/octo-repo",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "id": 6811672,
-    "is_template": false,
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "mirror_url": null,
-    "name": "octo-repo",
-    "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "open_issues": 97,
-    "open_issues_count": 97,
-    "owner": {
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/octo-org",
-      "id": 79927191,
-      "login": "octo-org",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/octo-org"
-    },
-    "private": false,
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "pushed_at": "2022-01-07T21:57:21Z",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "size": 144,
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "topics": [],
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "updated_at": "2022-01-07T21:57:24Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "visibility": "public",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/25328854?v=4",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/octocat",
-    "id": 25328754,
-    "login": "octocat",
-    "node_id": "MDQ6VXNlcjI1MzI4ODU0",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/octocat"
-  },
-  "workflow": ".github/workflows/hello-world-workflow.yml"
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + resolved - A comment thread on a + pull request was marked as resolved. +
      • +
    • + unresolved - A previously resolved + comment thread on a pull request was marked as + unresolved. +
      • +
    +
    +
    +
    +
    +
    +
    +
    pull_requestobject
    +
    +
    + The + pull request + the thread pertains to. +
    +
    +
    +
    +
    +
    +
    threadobject
    +
    +
    The thread that was affected.
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "resolved", "pull_request": { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118", "id": + 873298238, "node_id": "PR_kwDOEL39TM40DXk-", "html_url": + "https://github.com/octo-org/octo-repo/pull/118", "diff_url": + "https://github.com/octo-org/octo-repo/pull/118.diff", + "patch_url": + "https://github.com/octo-org/octo-repo/pull/118.patch", + "issue_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/118", + "number": 118, "state": "open", "locked": false, "title": "Create + issue-comment", "user": { "login": "octocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true }, "body": "Issue comment test", + "created_at": "2022-03-07T16:14:34Z", "updated_at": + "2022-03-21T09:21:38Z", "closed_at": null, "merged_at": null, + "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1", + "assignee": null, "assignees": [], "requested_reviewers": [], + "requested_teams": [], "labels": [], "milestone": null, "draft": + false, "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits", + "review_comments_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments", + "review_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "head": { "label": "octo-org:issue-comment", "ref": + "issue-comment", "sha": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "user": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "repo": { "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" } }, "base": { "label": + "octo-org:master", "ref": "master", "sha": + "fcaaddec44575a657bf81b049208b2ce139da3ca", "user": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "repo": { "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118" }, + "html": { "href": "https://github.com/octo-org/octo-repo/pull/118" + }, "issue": { "href": + "https://api.github.com/repos/octo-org/octo-repo/issues/118" }, + "comments": { "href": + "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments" + }, "review_comments": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments" + }, "review_comment": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}" + }, "commits": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits" + }, "statuses": { "href": + "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf" + } }, "author_association": "CONTRIBUTOR", "auto_merge": null, + "active_lock_reason": null }, "thread": { "node_id": + "PRRT_kwDOEL39TM4w7XDQ", "comments": [ { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280", + "pull_request_review_id": 901921390, "id": 820867280, "node_id": + "PRRC_kwDOEL39TM4w7XDQ", "diff_hunk": "@@ -0,0 +1 @@\n+issue + comment", "path": "issue-comment", "position": 1, + "original_position": 1, "commit_id": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "original_commit_id": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "user": { "login": + "jide2020", "id": 64502150, "node_id": "MDQ6VXNlcjY0NTAyMTUw", + "avatar_url": + "https://avatars.githubusercontent.com/u/64502150?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/jide2020", + "html_url": "https://github.com/jide2020", "followers_url": + "https://api.github.com/users/jide2020/followers", + "following_url": + "https://api.github.com/users/jide2020/following{/other_user}", + "gists_url": + "https://api.github.com/users/jide2020/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/jide2020/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/jide2020/subscriptions", + "organizations_url": "https://api.github.com/users/jide2020/orgs", + "repos_url": "https://api.github.com/users/jide2020/repos", + "events_url": + "https://api.github.com/users/jide2020/events{/privacy}", + "received_events_url": + "https://api.github.com/users/jide2020/received_events", "type": + "User", "site_admin": false }, "body": "sup", "created_at": + "2022-03-07T16:16:48Z", "updated_at": "2022-03-07T16:16:58Z", + "html_url": + "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280", + "pull_request_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118", + "author_association": "COLLABORATOR", "_links": { "self": { + "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280" + }, "html": { "href": + "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280" + }, "pull_request": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118" } }, + "reactions": { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions", + "total_count": 0, "+1": 0, "-1": 0, "laugh": 0, "hooray": 0, + "confused": 0, "heart": 0, "rocket": 0, "eyes": 0 }, "start_line": + null, "original_start_line": null, "start_side": null, "line": 1, + "original_line": 1, "side": "RIGHT" } ] }, "repository": { "id": + 280886604, "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" }, "organization": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "description": "" }, "sender": { "login": "octocat", "id": + 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true } } +
    + -

    - - workflow_job -

    -

    - A GitHub Actions workflow job has been queued, is in progress, or has - been completed on a repository. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • queued - A new job was created.
      • -
    • - in_progress - The job has started processing on - the runner. -
      • -
    • - completed - The status of the job is - completed. -
      • -
    -
    workflow_jobobject - The workflow job. Many workflow_job keys, such as - head_sha, conclusion, and - started_at are the same as those in a - check_run object. -
    workflow_job[status]string - The current status of the job. Can be queued, - in_progress, or completed. -
    workflow_job[labels]array - Custom labels for the job. Specified by the - "runs-on" attribute +
    +

    + push +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you push more than three tags at once. +

    + One or more commits are pushed to a repository branch or tag. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    refstring
    +
    +
    + The full + git ref + that was pushed. Example: + refs/heads/main or + refs/tags/v3.14.1. +
    +
    +
    +
    +
    +
    +
    beforestring
    +
    +
    + The SHA of the most recent commit on + ref before the push. +
    +
    +
    +
    +
    +
    +
    afterstring
    +
    +
    + The SHA of the most recent commit on + ref after the push. +
    +
    +
    +
    +
    +
    +
    createdboolean
    +
    +
    + Whether this push created the ref. +
    +
    +
    +
    +
    +
    +
    deletedboolean
    +
    +
    + Whether this push deleted the ref. +
    +
    +
    +
    +
    +
    +
    forcedboolean
    +
    +
    + Whether this push was a force push of the + ref. +
    +
    +
    +
    +
    +
    +
    head_commitobject
    +
    +
    + For pushes where after is or points to + a commit object, an expanded representation of that + commit. For pushes where after refers + to an annotated tag object, an expanded + representation of the commit pointed to by the + annotated tag. +
    +
    +
    +
    +
    +
    +
    comparestring
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    commitsarray
    +
    +
    + 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.) +
    +
    +
    +
    +
    +
    +
    commits[][id]string
    +
    +
    The SHA of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][timestamp]string +
    +
    +
    The ISO 8601 timestamp of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][message]string +
    +
    +
    The commit message.
    +
    +
    +
    +
    +
    +
    + commits[][author]object +
    +
    +
    The git author of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][author][name]string +
    +
    +
    The git author's name.
    +
    +
    +
    +
    +
    +
    + commits[][author][email]string +
    +
    +
    The git author's email address.
    +
    +
    +
    +
    +
    +
    commits[][url]url
    +
    +
    URL that points to the commit API resource.
    +
    +
    +
    +
    +
    +
    + commits[][distinct]boolean +
    +
    +
    + Whether this commit is distinct from any that have + been pushed before. +
    +
    +
    +
    +
    +
    +
    + commits[][added]array +
    +
    +
    + An array of files added in the commit. For extremely + large commits where GitHub Enterprise Server is + unable to calculate this list in a timely manner, + this may be empty even if files were added. +
    +
    +
    +
    +
    +
    +
    + commits[][modified]array +
    +
    +
    + An array of files modified by the commit. For + extremely large commits where GitHub Enterprise + Server is unable to calculate this list in a timely + manner, this may be empty even if files were + modified. +
    +
    +
    +
    +
    +
    +
    + commits[][removed]array +
    +
    +
    + An array of files removed in the commit. For + extremely large commits where GitHub Enterprise + Server is unable to calculate this list in a timely + manner, this may be empty even if files were + removed. +
    +
    +
    +
    +
    +
    +
    pusherobject
    +
    +
    The user who pushed the commits.
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "refs/tags/simple-tag", "before": + "0000000000000000000000000000000000000000", "after": + "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "created": true, + "deleted": false, "forced": false, "base_ref": null, "compare": + "https://octocoders.github.io/Codertocat/Hello-World/compare/simple-tag", + "commits": [], "head_commit": { "id": + "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "tree_id": + "4b825dc642cb6eb9a060e54bf8d69288fbee4904", "distinct": true, + "message": "Adding a .gitignore file", "timestamp": + "2019-05-15T15:20:41Z", "url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "author": { "name": "Codertocat", "email": + "Codertocat@octocoders.github.io", "username": "Codertocat" }, + "committer": { "name": "Codertocat", "email": + "Codertocat@octocoders.github.io", "username": "Codertocat" }, + "added": [ ".gitignore" ], "removed": [], "modified": [] }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "name": "Codertocat", "email": + "Codertocat@octocoders.github.io", "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": 1557949027, "updated_at": "2019-05-15T19:38:15Z", + "pushed_at": 1557949103, "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master", "stargazers": 0, "master_branch": + "master" }, "pusher": { "name": "Codertocat", "email": + "Codertocat@octocoders.github.io" }, "enterprise": { "id": 1, + "slug": "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    workflow_job[runner_id]integer - The ID of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_name]string - The name of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_id]integer - The ID of the runner group that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_name]string - The name of the runner group that is running this job. This will - be null as long as - workflow_job[status] is queued. -
    repositoryobject - The - repositoryrelease + +
    +
    + Activity related to a release. The type of activity is specified + in the action property of the payload object. For + more information, see the "releases" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + published: a release, pre-release, + or draft of a release is published +
      • +
    • + unpublished: a release or + pre-release is deleted +
      • +
    • + created: a draft is saved, or a + release or pre-release is published without + previously being saved as a draft +
      • +
    • + edited: a release, pre-release, or + draft release is edited +
      • +
    • + deleted: a release, pre-release, or + draft release is deleted +
      • +
    • + prereleased: a pre-release is + created +
      • +
    • + released: a release is published, + or a pre-release is changed to a release +
      • +
    +
    +
    +
    +
    +
    +
    +
    + changes[body][from]string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from]string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    releaseobject
    +
    +
    + The + release + object. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "release": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2", + "assets_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets", + "upload_url": + "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1", + "id": 2, "node_id": "MDc6UmVsZWFzZTI=", "tag_name": "0.0.1", + "target_commitish": "master", "name": null, "draft": false, + "author": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "prerelease": false, + "created_at": "2019-05-15T19:37:08Z", "published_at": + "2019-05-15T19:38:20Z", "assets": [], "tarball_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1", + "zipball_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1", + "body": null }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + + +
    +
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "in_progress",
-  "workflow_job": {
-    "id": 2832853555,
-    "run_id": 940463255,
-    "run_url": "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255",
-    "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55",
-    "head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055",
-    "url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555",
-    "html_url": "https://github.com/octo-org/example-workflow/runs/2832853555",
-    "status": "in_progress",
-    "conclusion": null,
-    "started_at": "2021-06-15T19:22:27Z",
-    "completed_at": null,
-    "name": "Test workflow",
-    "steps": [
-      {
-        "name": "Set up job",
-        "status": "in_progress",
-        "conclusion": null,
-        "number": 1,
-        "started_at": "2021-06-15T19:22:27.000Z",
-        "completed_at": null
-      }
-    ],
-    "check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555",
-    "labels": [
-      "gpu",
-      "db-app",
-      "dc-03"
-    ],
-    "runner_id": 1,
-    "runner_name": "my runner",
-    "runner_group_id": 2,
-    "runner_group_name": "my runner group"
-  },
-  "repository": {
-    "id": 376034443,
-    "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55",
-    "name": "example-workflow",
-    "full_name": "octo-org/example-workflow",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 33435655,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-      "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/example-workflow",
-    "description": "Test workflow",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/example-workflow",
-    "forks_url": "https://api.github.com/repos/octo-org/example-workflow/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/example-workflow/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/example-workflow/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/example-workflow/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/example-workflow/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/example-workflow/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/example-workflow/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/example-workflow/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/example-workflow/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/example-workflow/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/example-workflow/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/example-workflow/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/example-workflow/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/example-workflow/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/example-workflow/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/example-workflow/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/example-workflow/deployments",
-    "created_at": "2021-06-11T13:29:13Z",
-    "updated_at": "2021-06-11T13:33:01Z",
-    "pushed_at": "2021-06-11T13:32:58Z",
-    "git_url": "git://github.com/octo-org/example-workflow.git",
-    "ssh_url": "git@github.com:octo-org/example-workflow.git",
-    "clone_url": "https://github.com/octo-org/example-workflow.git",
-    "svn_url": "https://github.com/octo-org/example-workflow",
-    "homepage": null,
-    "size": 1,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 33435655,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "description": "octo-org"
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 319655,
-    "node_id": "MDQ6VXNlcjMxOTY1NQ55",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    + repository_dispatch + +
    +
    + This event occurs when a GitHub App sends a + POST request to the "Create a repository dispatch event" endpoint. +
    +

    Availability

    + +

    Webhook payload object

    +
    +
    + + + + + + + + + + +
    Headers
    Name, Type, Description
    +
    +
    +

    Webhook payload example

    +
    + { "action": "on-demand-test", "branch": "master", + "client_payload": { "unit": false, "integration": true }, + "repository": { "id": 17273051, "node_id": + "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", "name": "octo-repo", + "full_name": "octo-org/octo-repo", "private": true, "owner": { + "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": + "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "My first + repo on GitHub!", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2014-02-28T02:42:51Z", "updated_at": + "2018-10-10T15:58:51Z", "pushed_at": "2018-10-10T15:58:47Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 59, "stargazers_count": 0, "watchers_count": 0, "language": + "JavaScript", "has_issues": true, "has_projects": true, + "has_downloads": true, "has_wiki": true, "has_pages": false, + "forks_count": 1, "mirror_url": null, "archived": false, + "open_issues_count": 23, "license": null, "forks": 1, + "open_issues": 23, "watchers": 0, "default_branch": "master" }, + "organization": { "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars3.githubusercontent.com/u/6811672?v=4", + "description": "Working better together!" }, "sender": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "installation": { "id": 375706, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2" } + } +
    +
    -

    - - workflow_run -

    -

    - When a GitHub Actions workflow run is requested or completed. For more - information, see "Events that trigger workflows." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of - requested or completed. -
    workflow_runobject - The workflow run. Includes information such as - artifacts_url, check_suite_id, - conclusion, head_branch, and - head_sha. -
    workflowobjectThe workflow that generated the workflow run.
    organizationobject - Webhook payloads contain the - organization +
    +

    +

    repositoryobject - The + repository + +
    +
    + Activity related to a repository. The type of activity is + specified in the action property of the payload + object. For more information, see the "repositories" REST API. +
    +

    Availability

    +
      +
    • + Repository webhooks receive all event types except + deleted +
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Metadata permission receive + all event types except deleted +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. This can be one of: +
      +
    • + created - A repository is created. +
      • +
    • + deleted - A repository is deleted. +
      • +
    • + archived - A repository is + archived. +
      • +
    • + unarchived - A repository is + unarchived. +
      • +
    • + anonymous_access_enabled - A + repository is + enabled for anonymous Git access, anonymous_access_disabled - A + repository is + disabled for anonymous Git access +
      • +
    • + edited - A repository's information + is edited. +
      • +
    • + renamed - A repository is renamed. +
      • +
    • + transferred - A repository is + transferred. +
      • +
    • + publicized - A repository is made + public. +
      • +
    • + privatized - A repository is made + private. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "publicized", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + + +
    +
    +

    + repository_vulnerability_alert +

    +
    +
    +

    + This event occurs when there is activity relating to a security + vulnerability alert in a repository. +

    +

    + Note: This event is deprecated. Use the + dependabot_alert event instead. +

    +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object

    +
    +

    Action type

    +
    + +
    +
    +

    A repository vulnerability alert was created.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    + actionstringRequired +
    +
    +
    +
    +

    + Value: create +

    +
    +
    +
    +
    +
    +
    + alertRequired +
    +
    +
    +
    +
    +
    +
    +
    +
    enterpriseobject
    +
    +

    An enterprise on GitHub.

    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    +

    + The GitHub App installation. This property is + included when the event is configured for and sent + to a GitHub App. +

    +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +

    A GitHub organization.

    +
    +
    +
    +
    +
    +
    + repositoryobjectRequired +
    +
    +

    A repository on GitHub.

    +
    +
    +
    +
    +
    +
    + senderobjectRequired +
    +
    +

    A GitHub user.

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + secret_scanning_alert +

    +
    +
    + Activity related to secret scanning alerts in a repository. The + type of activity is specified in the action property of the + payload object. For more information, see the "secret scanning API." +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Secret scanning alerts permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. This can be either + created, resolved, or + reopened. +
    +
    +
    +
    +
    +
    +
    alertobject
    +
    +
    + The secret scanning alert involved in the event. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    + If the action is + resolved or reopened, the + sender object will be the user that + triggered the event. The sender object + is empty for all other actions. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "reopened", "alert": { "number": 191, "secret_type": + "adafruit_io_key", "resolution": null, "resolved_by": null, + "resolved_at": null }, "repository": { "id": 257423561, "node_id": + "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": true, "owner": { + "login": "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2020-04-20T22:59:11Z", "updated_at": + "2020-11-24T01:37:33Z", "pushed_at": "2020-11-24T01:37:31Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 1156, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": + false, "has_projects": false, "has_downloads": true, "has_wiki": + false, "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 3, + "license": null, "forks": 0, "open_issues": 3, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "url": + "https://api.github.com/orgs/Codertocat", "repos_url": + "https://api.github.com/orgs/Codertocat/repos", "events_url": + "https://api.github.com/orgs/Codertocat/events", "hooks_url": + "https://api.github.com/orgs/Codertocat/hooks", "issues_url": + "https://api.github.com/orgs/Codertocat/issues", "members_url": + "https://api.github.com/orgs/Codertocat/members{/member}", + "public_members_url": + "https://api.github.com/orgs/Codertocat/public_members{/member}", + "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "description": "Demos and testing of GitHub security products" }, + "sender": { "login": "Codertocat", "id": 10136561, "node_id": + "MDQ6VXNlcjEwMTM2NTYx", "avatar_url": + "https://avatars1.githubusercontent.com/u/10136561?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": true } } +
    +
    +
    +
    +
    +

    + security_advisory +

    +
    +
    + Activity related to a security advisory that has been reviewed by + GitHub. A GitHub-reviewed security advisory provides information + about security-related vulnerabilities in software on GitHub.The + security advisory dataset also powers the GitHub Dependabot + alerts. For more information, see "About Dependabot alerts." +
    +

    Availability

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. The action can be one + of published, updated, + performed, or + withdrawn for all new events. +
    +
    +
    +
    +
    +
    +
    + security_advisoryobject +
    +
    +
    + The details of the security advisory, including + summary, description, and severity. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "security_advisory": { "ghsa_id": + "GHSA-rf4j-j272-fj86", "summary": "Moderate severity vulnerability + that affects django", "description": + "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before + 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain + potentially sensitive information by leveraging data exposure from + the confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive.", "severity": "moderate", + "identifiers": [ { "value": "GHSA-rf4j-j272-fj86", "type": "GHSA" + }, { "value": "CVE-2018-6188", "type": "CVE" } ], "references": [ + { "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" } ], + "published_at": "2018-10-03T21:13:54Z", "updated_at": + "2018-10-03T21:13:54Z", "withdrawn_at": null, "vulnerabilities": [ + { "package": { "ecosystem": "pip", "name": "django" }, "severity": + "moderate", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { "identifier": "2.0.2" } }, { "package": + { "ecosystem": "pip", "name": "django" }, "severity": "moderate", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { "identifier": "1.11.10" } } ] } } +
    +
    +
    +
    +
    +

    + star +

    +
    +
    + Activity related to a repository being starred. The type of + activity is specified in the action property of the + payload object. For more information, see the "starring" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be created or + deleted. +
    +
    +
    +
    +
    +
    +
    starred_atstring
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "starred_at": "2019-05-15T15:20:40Z", + "repository": { "id": 186853002, "node_id": + "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", "updated_at": + "2019-05-15T15:20:40Z", "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 1, + "watchers_count": 1, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 1, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + status +

    +
    +
    + When the status of a Git commit changes. For more information, see + the "statuses" REST API. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Commit statuses permission +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    idinteger
    +
    +
    The unique identifier of the status.
    +
    +
    +
    +
    +
    +
    shastring
    +
    +
    The Commit SHA.
    +
    +
    +
    +
    +
    +
    statestring
    +
    +
    + The new state. Can be pending, + success, failure, or + error. +
    +
    +
    +
    +
    +
    +
    descriptionstring
    +
    +
    + The optional human-readable description added to the + status. +
    +
    +
    +
    +
    +
    +
    target_urlstring
    +
    +
    The optional link added to the status.
    +
    +
    +
    +
    +
    +
    branchesarray
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "id": 2, "sha": "4544205a385319fd846d5df4ed2e3b8173529d78", + "name": "Codertocat/Hello-World", "target_url": null, "context": + "default", "description": null, "state": "success", "commit": { + "sha": "4544205a385319fd846d5df4ed2e3b8173529d78", "node_id": + "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=", + "commit": { "author": { "name": "Codertocat", "email": + "Codertocat@octocoders.github.io", "date": "2019-05-15T19:37:08Z" + }, "committer": { "name": "GitHub Enterprise", "email": + "noreply@octocoders.github.io", "date": "2019-05-15T19:37:08Z" }, + "message": "Initial commit", "tree": { "sha": + "1b13fc88733f95cc8cb16170f6990ef30d78acf4", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4" + }, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78", + "comment_count": 1, "verification": { "verified": false, "reason": + "unsigned", "signature": null, "payload": null } }, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments", + "author": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "committer": null, + "parents": [] }, "branches": [ { "name": "master", "commit": { + "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a" + }, "protected": false }, { "name": "changes", "commit": { "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1" + }, "protected": false }, { "name": "gh-pages", "commit": { "sha": + "3648135c2986115284ae152d90459473b15fd19c", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c" + }, "protected": false } ], "created_at": + "2019-05-15T19:38:21+00:00", "updated_at": + "2019-05-15T19:38:21+00:00", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + team +

    +
    +
    + Activity related to an organization's team. The type of activity + is specified in the action property of the payload + object. For more information, see the "teams" REST API. +
    +

    Availability

    +
      +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of + created, deleted, + edited, + added_to_repository, or + removed_from_repository. +
    +
    +
    +
    +
    +
    +
    teamobject
    +
    +
    The team itself.
    +
    +
    +
    +
    +
    +
    changesobject
    +
    +
    + The changes to the team if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[description][from]string +
    +
    +
    + The previous version of the description if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from]string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[privacy][from]string +
    +
    +
    + The previous version of the team's privacy if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][admin]boolean +
    +
    +
    + The previous version of the team member's + admin permission on a repository, if + the action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][pull]boolean +
    +
    +
    + The previous version of the team member's + pull permission on a repository, if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][push]boolean +
    +
    +
    + The previous version of the team member's + push permission on a repository, if the + action was edited. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The repository that was added or removed from to the + team's purview if the action was + added_to_repository, + removed_from_repository, or + edited. For + edited actions, + repository also contains the team's new + permission levels for the repository. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added_to_repository", "team": { "name": "github", + "id": 3, "node_id": "MDQ6VGVhbTM=", "slug": "github", + "description": "Open-source team", "privacy": "secret", "url": + "https://octocoders.github.io/api/v3/teams/3", "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master", "permissions": { "pull": true, "push": + false, "admin": false } }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + team_add +

    +
    +
    + When a repositoryrepository is added to a team. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object

    +
    +
    + - where the event occurred. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "organization": {
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "description": "",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "id": 33435682,
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "login": "Codertocat",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "url": "https://api.github.com/orgs/Codertocat"
-  },
-  "repository": {
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "created_at": "2020-07-29T09:57:16Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "fork": false,
-    "forks": 0,
-    "forks_count": 0,
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "full_name": "Codertocat/Hello-World",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "id": 283462325,
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "mirror_url": null,
-    "name": "Hello-World",
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "open_issues": 0,
-    "open_issues_count": 0,
-    "owner": {
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/Codertocat",
-      "id": 33435682,
-      "login": "Codertocat",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/Codertocat"
-    },
-    "private": true,
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "pushed_at": "2020-07-29T10:06:16Z",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "size": 0,
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "updated_at": "2020-07-29T10:06:18Z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars3.githubusercontent.com/u/54248166?v=4",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/Codertocat",
-    "id": 54248166,
-    "login": "Codertocat",
-    "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/Codertocat"
-  },
-  "workflow": {
-    "badge_url": "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg",
-    "created_at": "2021-12-15T20:11:38.000Z",
-    "html_url": "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml",
-    "id": 16340987,
-    "name": "Manually triggered workflow",
-    "node_id": "W_kwDOF6lyTM4A-Vf7",
-    "path": ".github/workflows/syntax.yml",
-    "state": "active",
-    "updated_at": "2021-12-16T18:40:41.000Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  },
-  "workflow_run": {
-    "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts",
-    "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel",
-    "check_suite_id": 4683454167,
-    "check_suite_node_id": "CS_kwDOF6lyTM8AAAABFyfW1w",
-    "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167",
-    "conclusion": null,
-    "created_at": "2021-12-16T19:37:22Z",
-    "event": "workflow_dispatch",
-    "head_branch": "main",
-    "head_commit": {
-      "author": {
-        "email": "octocat@github.com",
-        "name": "Mona Lisa"
-      },
-      "committer": {
-        "email": "noreply@github.com",
-        "name": "GitHub"
-      },
-      "id": "5779607b49aab1200488439f02372c57b4f75444",
-      "message": "Update milestone-created.yml",
-      "timestamp": "2021-12-16T19:37:14Z",
-      "tree_id": "8181cee091cf9627ac07c3cc4b94c015a1d56706"
-    },
-    "head_repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "head_sha": "5779607b49aab1200488439f02372c57b4f75444",
-    "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1589141559",
-    "id": 1589141559,
-    "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs",
-    "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs",
-    "name": "Manually triggered workflow",
-    "node_id": "WFR_kwLOF6lyTM5euGA3",
-    "previous_attempt_url": null,
-    "pull_requests": [],
-    "repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun",
-    "run_attempt": 1,
-    "run_number": 36,
-    "run_started_at": "2021-12-16T19:37:22Z",
-    "status": "queued",
-    "updated_at": "2021-12-16T19:37:22Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559",
-    "workflow_id": 16340987,
-    "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    teamobject
    +
    +
    + The + team + that was modified. Note: Older + events may not include this in the payload. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "team": { "name": "github", "id": 3, "node_id": "MDQ6VGVhbTM=", + "slug": "github", "description": "Open-source team", "privacy": + "secret", "url": "https://octocoders.github.io/api/v3/teams/3", + "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false } } +
    + + +
    +
    +

    + user +

    +
    +
    + When a user is created or deleted. +
    +

    Availability

    +
      +
    • + GitHub Enterprise webhooks. For more information, "Global webhooks." +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + +
    Headers
    Name, Type, Description
    +
    +
    +

    Webhook payload example

    +
    + { "user": { "login": "Snowtocat", "id": 16, "node_id": + "MDQ6VXNlcjE2", "avatar_url": + "https://octocoders.github.io/avatars/u/16?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Snowtocat", + "html_url": "https://octocoders.github.io/Snowtocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/received_events", + "type": "User", "site_admin": false }, "action": "created", + "enterprise": { "id": 1, "slug": "github", "name": "GitHub", + "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Snowtocat", "id": 16, "node_id": + "MDQ6VXNlcjE2", "avatar_url": + "https://octocoders.github.io/avatars/u/16?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Snowtocat", + "html_url": "https://octocoders.github.io/Snowtocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + watch +

    +
    +
    + When someone stars a repository. The type of activity is specified + in the action property of the payload object. For + more information, see the "starring" REST API.The event’s actor is the + user + who starred a repository, and the event’s repository is the + repository + that was starred. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Currently, can only + be started. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installationobject
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "started", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:09Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 1, + "watchers_count": 1, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 1, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + workflow_dispatch +

    +
    +
    + This event occurs when someone triggers a workflow run on GitHub + or sends a POST request to the "Create a workflow dispatch event" endpoint. For more information, see "Events that trigger workflows." +
    +

    Availability

    +
      +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    inputsobject
    +
    +
    + Inputs to the workflow. Each key represents the name + of the input while its value represents the value of + that input. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    refstring
    +
    +
    + The branch or tag from which the workflow was run. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    workflowstring
    +
    +
    + Relative path to the workflow file which contains + the workflow. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "inputs": { "name": "Mona the Octocat" }, "organization": { + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "description": null, "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "id": 79927191, + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "login": "octo-org", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "repos_url": "https://api.github.com/orgs/octo-org/repos", "url": + "https://api.github.com/orgs/octo-org" }, "ref": + "refs/heads/main", "repository": { "allow_forking": true, + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "archived": false, "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "created_at": "2021-08-16T21:34:28Z", "default_branch": "main", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "disabled": false, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks": 1, "forks_count": 1, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_url": "git://github.com/octo-org/octo-repo.git", + "has_downloads": true, "has_issues": true, "has_pages": false, + "has_projects": true, "has_wiki": true, "homepage": null, + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 6811672, "is_template": false, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "language": null, "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "license": null, "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "mirror_url": null, "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "open_issues": 97, "open_issues_count": 97, "owner": { + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": false, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "pushed_at": "2022-01-07T21:57:21Z", "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "size": 144, "ssh_url": "git@github.com:octo-org/octo-repo.git", + "stargazers_count": 0, "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "svn_url": "https://github.com/octo-org/octo-repo", "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", "topics": + [], "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "updated_at": "2022-01-07T21:57:24Z", "url": + "https://api.github.com/repos/octo-org/octo-repo", "visibility": + "public", "watchers": 0, "watchers_count": 0 }, "sender": { + "avatar_url": + "https://avatars.githubusercontent.com/u/25328854?v=4", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octocat", "id": + 25328754, "login": "octocat", "node_id": "MDQ6VXNlcjI1MzI4ODU0", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": + "https://api.github.com/users/octocat/received_events", + "repos_url": "https://api.github.com/users/octocat/repos", + "site_admin": true, "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", "type": + "User", "url": "https://api.github.com/users/octocat" }, + "workflow": ".github/workflows/hello-world-workflow.yml" } +
    +
    +
    +
    +
    +

    + workflow_job +

    +
    +
    + A GitHub Actions workflow job has been queued, is in progress, or + has been completed on a repository. The type of activity is + specified in the action property of the payload + object. +
    +

    Availability

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • Enterprise webhooks
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action performed. Can be one of: +
      +
    • + queued - A new job was created. +
      • +
    • + in_progress - The job has started + processing on the runner. +
      • +
    • + completed - The + status of the job is + completed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    workflow_jobobject
    +
    +
    + The workflow job. Many + workflow_job keys, such as + head_sha, conclusion, and + started_at are the same as those in a + check_run + object. +
    +
    +
    +
    +
    +
    +
    + workflow_job[status]string +
    +
    +
    + The current status of the job. Can be + queued, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + workflow_job[labels]array +
    +
    +
    + Custom labels for the job. Specified by the + "runs-on" attribute + in the workflow YAML. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_id]integer +
    +
    +
    + The ID of the runner that is running this job. This + will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_name]string +
    +
    +
    + The name of the runner that is running this job. + This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_group_id]integer +
    +
    +
    + The ID of the runner group that is running this job. + This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_group_name]string +
    +
    +
    + The name of the runner group that is running this + job. This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "in_progress", "workflow_job": { "id": 2832853555, + "run_id": 940463255, "run_url": + "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255", + "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55", "head_sha": + "e3103f8eb03e1ad7f2331c5446b23c070fc54055", "url": + "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555", + "html_url": + "https://github.com/octo-org/example-workflow/runs/2832853555", + "status": "in_progress", "conclusion": null, "started_at": + "2021-06-15T19:22:27Z", "completed_at": null, "name": "Test + workflow", "steps": [ { "name": "Set up job", "status": + "in_progress", "conclusion": null, "number": 1, "started_at": + "2021-06-15T19:22:27.000Z", "completed_at": null } ], + "check_run_url": + "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555", + "labels": [ "gpu", "db-app", "dc-03" ], "runner_id": 1, + "runner_name": "my runner", "runner_group_id": 2, + "runner_group_name": "my runner group" }, "repository": { "id": + 376034443, "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55", "name": + "example-workflow", "full_name": "octo-org/example-workflow", + "private": true, "owner": { "login": "octo-org", "id": 33435655, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/example-workflow", "description": + "Test workflow", "fork": false, "url": + "https://api.github.com/repos/octo-org/example-workflow", + "forks_url": + "https://api.github.com/repos/octo-org/example-workflow/forks", + "keys_url": + "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/example-workflow/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/example-workflow/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/example-workflow/events", + "assignees_url": + "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/example-workflow/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/example-workflow/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/example-workflow/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/example-workflow/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/example-workflow/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/example-workflow/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/example-workflow/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/example-workflow/merges", + "archive_url": + "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/example-workflow/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/example-workflow/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/example-workflow/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/example-workflow/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/example-workflow/deployments", + "created_at": "2021-06-11T13:29:13Z", "updated_at": + "2021-06-11T13:33:01Z", "pushed_at": "2021-06-11T13:32:58Z", + "git_url": "git://github.com/octo-org/example-workflow.git", + "ssh_url": "git@github.com:octo-org/example-workflow.git", + "clone_url": "https://github.com/octo-org/example-workflow.git", + "svn_url": "https://github.com/octo-org/example-workflow", + "homepage": null, "size": 1, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "main" }, "organization": { "login": "octo-org", + "id": 33435655, "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", + "url": "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "description": "octo-org" }, "sender": { "login": "octocat", "id": + 319655, "node_id": "MDQ6VXNlcjMxOTY1NQ55", "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true } } +
    +
    +
    +
    +
    +

    + workflow_run +

    +
    +
    + When a GitHub Actions workflow run is requested or completed. For + more information, see "Events that trigger workflows." +
    +

    Availability

    +
      +
    • + GitHub Apps with Actions or + Contents permissions +
      • +
    +

    Webhook payload object

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    actionstring
    +
    +
    + The action that was performed. Can be one of + requested or completed. +
    +
    +
    +
    +
    +
    +
    workflow_runobject
    +
    +
    + The workflow run. Includes information such as + artifacts_url, + check_suite_id, + conclusion, head_branch, + and head_sha. +
    +
    +
    +
    +
    +
    +
    workflowobject
    +
    +
    + The workflow that generated the workflow run. +
    +
    +
    +
    +
    +
    +
    organizationobject
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    repositoryobject
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    senderobject
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "completed", "organization": { "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "description": "", "events_url": + "https://api.github.com/orgs/Octocoders/events", "hooks_url": + "https://api.github.com/orgs/Octocoders/hooks", "id": 33435682, + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "login": "Codertocat", "members_url": + "https://api.github.com/orgs/Octocoders/members{/member}", + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "public_members_url": + "https://api.github.com/orgs/Octocoders/public_members{/member}", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "url": "https://api.github.com/orgs/Codertocat" }, "repository": { + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "archived": false, "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "created_at": "2020-07-29T09:57:16Z", "default_branch": "main", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "description": null, "disabled": false, "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "fork": false, "forks": 0, "forks_count": 0, "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "full_name": "Codertocat/Hello-World", "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "has_downloads": true, "has_issues": true, "has_pages": false, + "has_projects": true, "has_wiki": true, "homepage": null, + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "html_url": "https://github.com/Codertocat/Hello-World", "id": + 283462325, "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "language": null, "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "license": null, "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "mirror_url": null, "name": "Hello-World", "node_id": + "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=", "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/Codertocat", + "id": 33435682, "login": "Codertocat", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy", "organizations_url": + "https://api.github.com/users/Codertocat/orgs", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/Codertocat" + }, "private": true, "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "pushed_at": "2020-07-29T10:06:16Z", "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "size": 0, "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "stargazers_count": 0, "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "svn_url": "https://github.com/Codertocat/Hello-World", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "updated_at": "2020-07-29T10:06:18Z", "url": + "https://api.github.com/repos/Codertocat/Hello-World", "watchers": + 0, "watchers_count": 0 }, "sender": { "avatar_url": + "https://avatars3.githubusercontent.com/u/54248166?v=4", + "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/Codertocat", + "id": 54248166, "login": "Codertocat", "node_id": + "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", "organizations_url": + "https://api.github.com/users/Codertocat/orgs", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": true, "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", "type": + "User", "url": "https://api.github.com/users/Codertocat" }, + "workflow": { "badge_url": + "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg", + "created_at": "2021-12-15T20:11:38.000Z", "html_url": + "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml", + "id": 16340987, "name": "Manually triggered workflow", "node_id": + "W_kwDOF6lyTM4A-Vf7", "path": ".github/workflows/syntax.yml", + "state": "active", "updated_at": "2021-12-16T18:40:41.000Z", + "url": + "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" + }, "workflow_run": { "artifacts_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts", + "cancel_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel", + "check_suite_id": 4683454167, "check_suite_node_id": + "CS_kwDOF6lyTM8AAAABFyfW1w", "check_suite_url": + "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167", + "conclusion": null, "created_at": "2021-12-16T19:37:22Z", "event": + "workflow_dispatch", "head_branch": "main", "head_commit": { + "author": { "email": "octocat@github.com", "name": "Mona Lisa" }, + "committer": { "email": "noreply@github.com", "name": "GitHub" }, + "id": "5779607b49aab1200488439f02372c57b4f75444", "message": + "Update milestone-created.yml", "timestamp": + "2021-12-16T19:37:14Z", "tree_id": + "8181cee091cf9627ac07c3cc4b94c015a1d56706" }, "head_repository": { + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 396980812, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "owner": { "avatar_url": + "https://avatars.githubusercontent.com/u/79927191?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": true, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, + "head_sha": "5779607b49aab1200488439f02372c57b4f75444", + "html_url": + "https://github.com/octo-org/octo-repo/actions/runs/1589141559", + "id": 1589141559, "jobs_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs", + "logs_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs", + "name": "Manually triggered workflow", "node_id": + "WFR_kwLOF6lyTM5euGA3", "previous_attempt_url": null, + "pull_requests": [], "repository": { "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 396980812, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "owner": { "avatar_url": + "https://avatars.githubusercontent.com/u/79927191?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": true, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, + "rerun_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun", + "run_attempt": 1, "run_number": 36, "run_started_at": + "2021-12-16T19:37:22Z", "status": "queued", "updated_at": + "2021-12-16T19:37:22Z", "url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559", + "workflow_id": 16340987, "workflow_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" + } } +
    +
    diff --git a/cache/ghes-34/webhook-events-and-payloads.html b/cache/ghes-34/webhook-events-and-payloads.html index 6e2acc0cb..96f71ccc3 100644 --- a/cache/ghes-34/webhook-events-and-payloads.html +++ b/cache/ghes-34/webhook-events-and-payloads.html @@ -1,15 +1,19 @@
    -

    Webhook events and payloads

    +

    Webhook events and payloads

    -

    In this article

    -
    -
    +

    - For each webhook event, you can review when the event occurs, an example - payload, and descriptions about the payload object parameters. + Learn about when each webhook event occurs and what the payload contains.

    @@ -490,44 +710,32 @@

    In this article

    - When configuring a webhook, you can use the UI or API to choose which - events will send you payloads. Only subscribing to the specific events - you plan on handling limits the number of HTTP requests to your server. - You can also subscribe to all current and future events. By default, - webhooks are only subscribed to the push event. You can change the list - of subscribed events anytime. + When configuring a webhook, you can choose which events will send you + payloads. To limit the number of HTTP requests to your server, you + should only subscribe to the specific events that you plan on handling. + By default, webhooks installed on + GitHub Enterprise, an [organization][org-hooks], or a [repository][repo-hooks] are only + subscribed to the push event. By default, webhooks on GitHub Apps are + not subscribed to any events. You can change events that a webhook is + subscribed to at any time.

    You can create webhooks that subscribe to the events listed on this page. Each webhook event includes a description of the webhook properties and an example payload. For more information, see "Creating webhooks."

    -

    - - Webhook payload object common properties +

    + Webhook payload object common properties

    Each webhook event payload also contains properties unique to the event. @@ -538,9 +746,9 @@

    - - - + + + @@ -565,8 +773,7 @@

    @@ -605,9 +811,8 @@

    The unique properties for a webhook event are the same properties you'll find in the payload property when using the - Events API. One exception is the push event. The + Events API. + One exception is the push event. The unique properties of the push event webhook payload and the payload property in the Events API differ. The webhook payload contains more detailed information. @@ -621,121 +826,66 @@

    ensure delivery.

    -

    - - Delivery headers +

    + Delivery headers

    HTTP POST payloads that are delivered to your webhook's configured URL - endpoint will contain several special headers: + endpoint will contain several special headers.

    - -
    KeyTypeDescriptionKeyTypeDescription
    object The - repository where the event occurred. Webhook payloads contain the @@ -579,8 +786,7 @@

    		object Webhook payloads contain the - organization object when the webhook is configured for an organization or the @@ -595,8 +801,8 @@

    The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see "Building GitHub AppRegistering a GitHub App."

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HeaderDescription
    X-GitHub-EventName of the event that triggered the delivery.
    X-GitHub-Delivery - A - GUID - to identify the delivery. -
    X-GitHub-Enterprise-Version - The version of the GitHub Enterprise Server instance that sent the - HTTP POST payload. -
    X-GitHub-Enterprise-Host - The hostname of the GitHub Enterprise Server instance that sent - the HTTP POST payload. -
    X-Hub-Signature - This header is sent if the webhook is configured with a - secret. This is the HMAC hex digest of the request body, and is - generated using the SHA-1 hash function and the - secret as the HMAC key. - X-Hub-Signature is provided for compatibility with - existing integrations, and we recommend that you use the more - secure X-Hub-Signature-256 instead. -
    X-Hub-Signature-256 - This header is sent if the webhook is configured with a - secret. This is the HMAC hex digest of the request body, and is - generated using the SHA-256 hash function and the - secret as the HMAC key. -
    +
      +
    • + X-GitHub-Event: Name of the event that triggered the + delivery. +
      • +
    • + X-GitHub-Delivery: A + GUID + to identify the delivery. +
      • +
    • + X-GitHub-Enterprise-Version: The version of the GitHub + Enterprise Server instance that sent the HTTP POST payload. +
      • +
    • + X-GitHub-Enterprise-Host: The hostname of the GitHub + Enterprise Server instance that sent the HTTP POST payload. +
      • +
    • + X-Hub-Signature: This header is sent if the webhook is + configured with a + secret. This is the HMAC hex digest of the request body, and is generated + using the SHA-1 hash function and the secret as the HMAC + key. X-Hub-Signature is provided for + compatibility with existing integrations, and we recommend that you + use the more secure X-Hub-Signature-256 instead. +
      • +
    • + X-Hub-Signature-256: This header is sent if the webhook + is configured with a + secret. This is the HMAC hex digest of the request body, and is generated + using the SHA-256 hash function and the secret as the + HMAC key. +
      • +

    Also, the User-Agent for the requests will have the prefix GitHub-Hookshot/.

    -

    - - Example delivery +

    + Example delivery 

    > POST /payload HTTP/2
 
@@ -773,18674 +923,18303 @@ 
    
 >     ...
 >   }
 > }
    -

    - - branch_protection_rule -

    -

    - Activity related to a branch protection rule. For more information, see - "About branch protection rules." -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Administration repository permission -
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be created, - edited, or deleted. -
    ruleobject - The branch protection rule. Includes a name and all - the - branch protection settings +
    +
    +
    +

    + branch_protection_rule +

    +
    +
    + Activity related to a branch protection rule. For more + information, see "About branch protection rules." +
    +

    Availability for branch_protection_rule

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Administration repository + permission +
      • +
    +

    + Webhook payload object for branch_protection_rule +

    +
    +
    + - 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. - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    changesobject - If the action was edited, the changes to the rule. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created, + edited, or deleted. +
    +
    +
    +
    +
    +
    +
    rule object
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + If the action was edited, the changes + to the rule. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "edited", "rule": { "id": 21796960, "repository_id": + 259377789, "name": "production", "created_at": + "2021-08-19T12:16:32.000-04:00", "updated_at": + "2021-08-19T12:16:32.000-04:00", + "pull_request_reviews_enforcement_level": "off", + "required_approving_review_count": 1, + "dismiss_stale_reviews_on_push": false, + "require_code_owner_review": false, + "authorized_dismissal_actors_only": false, + "ignore_approvals_from_contributors": false, + "required_status_checks": [ "basic-CI" ], + "required_status_checks_enforcement_level": "non_admins", + "strict_required_status_checks_policy": false, + "signature_requirement_enforcement_level": "off", + "linear_history_requirement_enforcement_level": "off", + "admin_enforced": false, "allow_force_pushes_enforcement_level": + "off", "allow_deletions_enforcement_level": "off", + "merge_queue_enforcement_level": "off", + "required_deployments_enforcement_level": "off", + "required_conversation_resolution_level": "off", + "authorized_actors_only": true, "authorized_actor_names": [ + "Codertocat" ] }, "changes": { "authorized_actors_only": { "from": + false }, "authorized_actor_names": { "from": [] } }, "repository": + { "id": 17273051, "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", + "name": "octo-repo", "full_name": "octo-org/octo-repo", "private": + true, "owner": { "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "My first + repo on GitHub!", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2014-02-28T02:42:51Z", "updated_at": + "2021-03-11T14:54:13Z", "pushed_at": "2021-03-11T14:54:10Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "org-6811672@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 300, "stargazers_count": 0, "watchers_count": 0, "language": + "JavaScript", "has_issues": true, "has_projects": false, + "has_downloads": true, "has_wiki": false, "has_pages": true, + "forks_count": 0, "mirror_url": null, "archived": false, + "disabled": false, "open_issues_count": 39, "license": null, + "forks": 0, "open_issues": 39, "watchers": 0, "default_branch": + "main" }, "organization": { "login": "octo-org", "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "description": "Working better together!" }, "sender": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + cache_sync +

    +
    +
    + A Git ref has been successfully synced to a cache replica. For + more information, see "About repository caching." +
    +

    Availability for cache_sync

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for cache_sync

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    + cache_location string +
    +
    +
    + The location of the cache server that has been + updated. +
    +
    +
    +
    +
    +
    +
    ref string
    +
    +
    The ref that has been updated.
    +
    +
    +
    +
    +
    +
    before string
    +
    +
    + The OID of the ref on the cache replica before it + was updated. +
    +
    +
    +
    +
    +
    +
    after string
    +
    +
    + The OID of the ref on the cache replica after the + update. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "cache_location": "morocco", "ref": "refs/heads/main", + "before": "0000000000000000000000000000000000000000", "after": + "de40facb99837f9ca38a0d399b0d20fe135510eb", "repository": { "id": + 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "github-enterprise", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": + "https://octocoders.github.io/api/v3/users/github-enterprise", + "html_url": "https://octocoders.github.io/github-enterprise", + "followers_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + check_run +

    +
    +
    +

    + Note: The Checks API only looks for pushes in + the repository where the check suite or check run were 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. +

    + Check run activity has occurred. The type of activity is specified + in the action property of the payload object. For + more information, see the "check runs" REST API. +
    +

    Availability for check_run

    +
      +
    • + Repository webhooks only receive payloads for the + created and completed event types in a + repository +
      • +
    • + Organization webhooks only receive payloads for the + created and completed event types in + repositories +
      • +
    • + GitHub Apps with Checks read permission receive + payloads for the created and + completed events that occur in the repository where + the app is installed. The app must have + Checks write permission to receive the + rerequested and requested_action event + types. The rerequested and + requested_action event type payloads are only sent + to the GitHub App being requested. GitHub Apps with + Checks write permission are automatically + subscribed to this webhook event. +
      • +
    +

    Webhook payload object for check_run

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "edited",
-  "rule": {
-    "id": 21796960,
-    "repository_id": 259377789,
-    "name": "production",
-    "created_at": "2021-08-19T12:16:32.000-04:00",
-    "updated_at": "2021-08-19T12:16:32.000-04:00",
-    "pull_request_reviews_enforcement_level": "off",
-    "required_approving_review_count": 1,
-    "dismiss_stale_reviews_on_push": false,
-    "require_code_owner_review": false,
-    "authorized_dismissal_actors_only": false,
-    "ignore_approvals_from_contributors": false,
-    "required_status_checks": [
-      "basic-CI"
-    ],
-    "required_status_checks_enforcement_level": "non_admins",
-    "strict_required_status_checks_policy": false,
-    "signature_requirement_enforcement_level": "off",
-    "linear_history_requirement_enforcement_level": "off",
-    "admin_enforced": false,
-    "allow_force_pushes_enforcement_level": "off",
-    "allow_deletions_enforcement_level": "off",
-    "merge_queue_enforcement_level": "off",
-    "required_deployments_enforcement_level": "off",
-    "required_conversation_resolution_level": "off",
-    "authorized_actors_only": true,
-    "authorized_actor_names": [
-      "Codertocat"
-    ]
-  },
-  "changes": {
-    "authorized_actors_only": {
-      "from": false
-    },
-    "authorized_actor_names": {
-      "from": []
-    }
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be one of: +
      +
    • + created - A new check run was + created. +
      • +
    • + completed - The + status of the check run is + completed. +
      • +
    • + rerequested - Someone requested to + re-run your check run from the pull request UI. + See "About status checks" for more details about the GitHub UI. When + you receive a rerequested action, + you'll need to + create a new check run. Only the GitHub App that someone requests to + re-run the check will receive the + rerequested payload. +
      • +
    • + requested_action - Someone + requested an action your app provides to be + taken. Only the GitHub App someone requests to + perform an action will receive the + requested_action payload. To learn + more about check runs and requested actions, see + "Check runs and requested actions." +
      • +
    +
    +
    +
    +
    +
    +
    +
    check_run object
    +
    +
    + The + check_run. +
    +
    +
    +
    +
    +
    +
    + check_run[status] string +
    +
    +
    + The current status of the check run. Can be + queued, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + check_run[conclusion] string +
    +
    +
    + The result of the completed check run. Can be one of + success, failure, + neutral, cancelled, + timed_out, + action_required or stale. + This value will be null until the check + run has completed. +
    +
    +
    +
    +
    +
    +
    + check_run[name] string +
    +
    +
    The name of the check run.
    +
    +
    +
    +
    +
    +
    + check_run[check_suite][id] + integer +
    +
    +
    + The id of the check suite that this check run is + part of. +
    +
    +
    +
    +
    +
    +
    + check_run[check_suite][pull_requests] + array +
    +
    +
    + An array of pull requests that match this check + suite. A pull request matches a check suite if they + have the same + head_branch.

    Note: +
      +
    • + The head_sha of the check suite can + differ from the sha of the pull + request if subsequent pushes are made into the + PR. +
      • +
    • + When the check suite's + head_branch is in a forked + repository it will be null and the + pull_requests array will be empty. +
      • +
    +
    +
    +
    +
    +
    +
    +
    + check_run[check_suite][deployment] + object +
    +
    +
    + A deployment to a repository environment. This will + only be populated if the check run was created by a + GitHub Actions workflow job that references an + environment. +
    +
    +
    +
    +
    +
    +
    + requested_action object +
    +
    +
    The action requested by the user.
    +
    +
    +
    +
    +
    +
    + requested_action[identifier] + string +
    +
    +
    + The integrator reference of the action requested by + the user. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "check_run": { "id": 2, "node_id": + "MDg6Q2hlY2tSdW4y", "head_sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "external_id": "", + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/runs/2", + "details_url": "https://octocoders.io", "status": "queued", + "conclusion": null, "started_at": "2019-05-15T19:39:04Z", + "completed_at": null, "output": { "title": null, "summary": null, + "text": null, "annotations_count": 0, "annotations_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2/annotations" + }, "name": "Octocoders-linter", "check_suite": { "id": 9, + "node_id": "MDEwOkNoZWNrU3VpdGU5", "head_branch": "changes", + "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1", "status": + "queued", "conclusion": null, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9", + "before": "4544205a385319fd846d5df4ed2e3b8173529d78", "after": + "14977a7b5485400124827221a04bfb474bcd72d1", "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ], "app": { "id": 2, "node_id": + "MDM6QXBwMg==", "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:38:27Z" }, + "app": { "id": 2, "node_id": "MDM6QXBwMg==", "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ] }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - cache_sync -

    -

    - A Git ref has been successfully synced to a cache replica. For more - information, see "About repository caching." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    cache_locationstringThe location of the cache server that has been updated.
    refstringThe ref that has been updated.
    beforestring - The OID of the ref on the cache replica before it was updated. -
    afterstringThe OID of the ref on the cache replica after the update.
    repositoryobject - The - repository +
    +

    + check_suite +

    +
    +
    +

    + Note: The Checks API only looks for pushes in + the repository where the check suite or check run were 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. +

    + Check suite activity has occurred. The type of activity is + specified in the action property of the payload + object. For more information, see the "check suites" REST API. +
    +

    Availability for check_suite

    +
      +
    • + Repository webhooks only receive payloads for the + completed event types in a repository +
      • +
    • + Organization webhooks only receive payloads for the + completed event types in repositories +
      • +
    • + GitHub Apps with Checks read permission receive + payloads for the created and + completed events that occur in the repository where + the app is installed. The app must have + Checks write permission to receive the + requested and rerequested event types. + The requested and rerequested event + type payloads are only sent to the GitHub App being requested. + GitHub Apps with Checks write permission are + automatically subscribed to this webhook event. +
      • +
    +

    Webhook payload object for check_suite

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be: +
      +
    • + completed - All check runs in a + check suite have completed. +
      • +
    • + requested - Occurs when new code is + pushed to the app's repository. When you receive + the requested action events, you'll + need to + create a new check run. +
      • +
    • + rerequested - Occurs when someone + requests to re-run the entire check suite from + the pull request UI. When you receive the + rerequested action events, you'll + need to + create a new check run. See "About status checks" for more details about the GitHub UI. +
      • +
    +
    +
    +
    +
    +
    +
    +
    check_suite object
    +
    +
    + The + check_suite. +
    +
    +
    +
    +
    +
    +
    + check_suite[head_branch] + string +
    +
    +
    The head branch name the changes are on.
    +
    +
    +
    +
    +
    +
    + check_suite[head_sha] string +
    +
    +
    + The SHA of the most recent commit for this check + suite. +
    +
    +
    +
    +
    +
    +
    + check_suite[status] string +
    +
    +
    + The summary status for all check runs that are part + of the check suite. Can be queued, + requested, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + check_suite[conclusion] + string +
    +
    +
    + The summary conclusion for all check runs that are + part of the check suite. Can be one of + success, failure, + neutral, cancelled, + timed_out, + action_required or stale. + This value will be null until the check + run has completed. +
    +
    +
    +
    +
    +
    +
    + check_suite[url] string +
    +
    +
    + URL that points to the check suite API resource. +
    +
    +
    +
    +
    +
    +
    + check_suite[pull_requests] + array +
    +
    +
    + An array of pull requests that match this check + suite. A pull request matches a check suite if they + have the same + head_branch.

    Note: +
      +
    • + The head_sha of the check suite can + differ from the sha of the pull + request if subsequent pushes are made into the + PR. +
      • +
    • + When the check suite's + head_branch is in a forked + repository it will be null and the + pull_requests array will be empty. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "completed", "check_suite": { "id": 9, "node_id": + "MDEwOkNoZWNrU3VpdGU5", "head_branch": "changes", "head_sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "status": "completed", + "conclusion": "success", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9", + "before": "4544205a385319fd846d5df4ed2e3b8173529d78", "after": + "14977a7b5485400124827221a04bfb474bcd72d1", "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ], "app": { "id": 2, "node_id": + "MDM6QXBwMg==", "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:39:09Z", + "latest_check_runs_count": 1, "check_runs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs", + "head_commit": { "id": "14977a7b5485400124827221a04bfb474bcd72d1", + "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea", "message": + "Update README.md", "timestamp": "2019-05-15T19:38:01Z", "author": + { "name": "Codertocat", "email": "Codertocat@Octocoders.io" }, + "committer": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io" } } }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + code_scanning_alert +

    +
    +
    + Activity related to code scanning alerts in a repository. The type + of activity is specified in the action property of the payload + object. For more information, see "About code scanning." +
    +

    Availability for code_scanning_alert

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Code scanning alerts permission +
      • +
    +

    Webhook payload object for code_scanning_alert

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "cache_location": "morocco",
-  "ref": "refs/heads/main",
-  "before": "0000000000000000000000000000000000000000",
-  "after": "de40facb99837f9ca38a0d399b0d20fe135510eb",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "github-enterprise",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/github-enterprise",
-    "html_url": "https://octocoders.github.io/github-enterprise",
-    "followers_url": "https://octocoders.github.io/api/v3/users/github-enterprise/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/github-enterprise/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/github-enterprise/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/github-enterprise/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/github-enterprise/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/github-enterprise/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/github-enterprise/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/github-enterprise/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/github-enterprise/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. This can be one of + created, reopened_by_user, + closed_by_user, fixed, + appeared_in_branch, or + reopened. +
    +
    +
    +
    +
    +
    +
    alert object
    +
    +
    + The code scanning alert involved in the event. +
    +
    +
    +
    +
    +
    +
    ref string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    commit_oid string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    + If the action is + reopened_by_user or + closed_by_user, the + sender object will be the user that + triggered the event. The sender object + is github-enterprise for all other + actions. +
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "reopened", "alert": { "number": 10, "created_at": + "2020-07-22T14:06:31Z", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10", + "instances": [ { "ref": "refs/heads/main", "analysis_key": + ".github/workflows/workflow.yml:upload", "environment": "{}", + "state": "open" } ], "state": "open", "dismissed_by": null, + "dismissed_at": null, "dismissed_reason": null, "rule": { "id": + "Style/FrozenStringLiteralComment", "severity": "note", + "description": "Add the frozen_string_literal comment to the top + of files to help transition to frozen string literals by default." + }, "tool": { "name": "Rubocop", "version": null } }, "ref": + "refs/heads/main", "commit_oid": + "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": + 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", "updated_at": + "2019-05-15T15:19:27Z", "pushed_at": "2019-05-15T15:20:32Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "main" }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" } } +
    + -

    - - check_run -

    -

    - Check run activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check runs" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    +
    +

    + commit_comment +

    +
    +
    + A commit comment is created. The type of activity is specified in + the action property of the payload object. For more + information, see the "commit comment" REST API. +
    +

    Availability for commit_comment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for commit_comment

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    comment object
    +
    +
    + The + commit comment + resource. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2", + "id": 2, "node_id": "MDEzOkNvbW1pdENvbW1lbnQy", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "position": null, "line": + null, "path": null, "commit_id": + "4544205a385319fd846d5df4ed2e3b8173529d78", "created_at": + "2019-05-15T19:38:09Z", "updated_at": "2019-05-15T19:38:09Z", + "author_association": "OWNER", "body": "This is a really good + change! :+1:" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • created - A new check run was created.
      • -
    • - completed - The status of the check - run is completed. -
      • -
    • - rerequested - Someone requested to re-run your - check run from the pull request UI. See "About status checks" for more details about the GitHub UI. When you receive a - rerequested action, you'll need to - create a new check run. Only the GitHub App that someone requests to re-run the - check will receive the rerequested payload. -
      • -
    • - requested_action - Someone requested an action - your app provides to be taken. Only the GitHub App someone - requests to perform an action will receive the - requested_action payload. To learn more about - check runs and requested actions, see "Check runs and requested actions." -
      • -
    -
    check_runobject - The - check_run. -
    check_run[status]string - The current status of the check run. Can be queued, - in_progress, or completed. -
    check_run[conclusion]string - The result of the completed check run. Can be one of - success, failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_run[name]stringThe name of the check run.
    check_run[check_suite][id]integerThe id of the check suite that this check run is part of.
    check_run[check_suite][pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    check_run[check_suite][deployment]object - A deployment to a repository environment. This will only be - populated if the check run was created by a GitHub Actions - workflow job that references an environment. -
    requested_actionobjectThe action requested by the user.
    requested_action[identifier]string - The integrator reference of the action requested by the user. -
    repositoryobject - The - repository +
    +

    + create +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you create more than three tags at once. +

    + A Git branch or tag is created. For more information, see the "Git database" REST API. +
    +

    Availability for create

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for create

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    ref string
    +
    +
    + The + git ref + resource. +
    +
    +
    +
    +
    +
    +
    ref_type string
    +
    +
    + The type of Git ref object created in the + repository. Can be either branch or + tag. +
    +
    +
    +
    +
    +
    +
    + master_branch string +
    +
    +
    + The name of the repository's default branch (usually + main). +
    +
    +
    +
    +
    +
    +
    description string
    +
    +
    The repository's current description.
    +
    +
    +
    +
    +
    +
    pusher_type string
    +
    +
    + The pusher type for the event. Can be either + user or a deploy key. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "simple-tag", "ref_type": "tag", "master_branch": + "master", "description": null, "pusher_type": "user", + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:22Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + delete +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you delete more than three tags at once. +

    + A Git branch or tag is deleted. For more information, see the "Git database" REST API. +
    +

    Availability for delete

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for delete

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "check_run": {
-    "id": 2,
-    "node_id": "MDg6Q2hlY2tSdW4y",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "external_id": "",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/runs/2",
-    "details_url": "https://octocoders.io",
-    "status": "queued",
-    "conclusion": null,
-    "started_at": "2019-05-15T19:39:04Z",
-    "completed_at": null,
-    "output": {
-      "title": null,
-      "summary": null,
-      "text": null,
-      "annotations_count": 0,
-      "annotations_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2/annotations"
-    },
-    "name": "Octocoders-linter",
-    "check_suite": {
-      "id": 9,
-      "node_id": "MDEwOkNoZWNrU3VpdGU5",
-      "head_branch": "changes",
-      "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "status": "queued",
-      "conclusion": null,
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-      "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-      "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "pull_requests": [
-        {
-          "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-          "id": 2,
-          "number": 2,
-          "head": {
-            "ref": "changes",
-            "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-            "repo": {
-              "id": 118,
-              "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          },
-          "base": {
-            "ref": "master",
-            "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-            "repo": {
-              "id": 118,
-              "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          }
-        }
-      ],
-      "app": {
-        "id": 2,
-        "node_id": "MDM6QXBwMg==",
-        "owner": {
-          "login": "Octocoders",
-          "id": 6,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-          "html_url": "https://octocoders.github.io/Octocoders",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "name": "octocoders-linter",
-        "description": "",
-        "external_url": "https://octocoders.io",
-        "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-        "created_at": "2019-05-15T15:41:35Z",
-        "updated_at": "2019-05-15T15:41:35Z",
-        "permissions": {
-          "administration": "write",
-          "checks": "write",
-          "contents": "write",
-          "deployments": "write",
-          "issues": "write",
-          "metadata": "read",
-          "pages": "write",
-          "pull_requests": "write",
-          "repository_hooks": "write",
-          "repository_projects": "write",
-          "vulnerability_alerts": "read",
-          "statuses": "write",
-          "members": "write",
-          "organization_user_blocking": "write",
-          "organization_projects": "write",
-          "team_discussions": "write",
-          "organization_hooks": "write",
-          "repository_pre_receive_hooks": "write",
-          "organization_pre_receive_hooks": "write"
-        },
-        "events": [
-          "check_run",
-          "check_suite",
-          "commit_comment",
-          "create",
-          "delete",
-          "deployment",
-          "deployment_status",
-          "fork",
-          "gollum",
-          "issues",
-          "issue_comment",
-          "label",
-          "member",
-          "membership",
-          "milestone",
-          "organization",
-          "page_build",
-          "project",
-          "project_card",
-          "project_column",
-          "public",
-          "pull_request",
-          "pull_request_review",
-          "pull_request_review_comment",
-          "push",
-          "release",
-          "repository",
-          "status",
-          "team",
-          "team_add",
-          "watch"
-        ]
-      },
-      "created_at": "2019-05-15T19:38:27Z",
-      "updated_at": "2019-05-15T19:38:27Z"
-    },
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ]
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    ref string
    +
    +
    + The + git ref + resource. +
    +
    +
    +
    +
    +
    +
    ref_type string
    +
    +
    + The type of Git ref object deleted in the + repository. Can be either branch or + tag. +
    +
    +
    +
    +
    +
    +
    pusher_type string
    +
    +
    + The pusher type for the event. Can be either + user or a deploy key. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "ref": "simple-tag", "ref_type": "tag", "pusher_type": "user", + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - check_suite -

    -

    - Check suite activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check suites" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    +
    +

    + deploy_key +

    +
    +
    + A deploy key is added or removed from a repository. The type of + activity is specified in the action property of the + payload object. For more information, see the "Deploy keys" REST API. +
    +

    Availability for deploy_key

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for deploy_key

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be either + created or deleted. +
    +
    +
    +
    +
    +
    +
    key object
    +
    +
    + The + deploy key + resource. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "key": { "id": 100, "key": "ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z", + "url": + "https://api.github.com/repos/Codertocat/Hello-World/keys/100", + "title": "hey-its-a-deploy-key", "verified": true, "created_at": + "2019-04-02T17:37:07Z", "read_only": true }, "repository": { "id": + 135493233, "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "owner": { + "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "private": false, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-05-30T20:18:04Z", "updated_at": + "2018-05-30T20:18:50Z", "pushed_at": "2018-05-30T20:18:48Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 1, "license": null, + "forks": 0, "open_issues": 1, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be: -
      -
    • - completed - All check runs in a check suite have - completed. -
      • -
    • - requested - Occurs when new code is pushed to the - app's repository. When you receive the - requested action events, you'll need to - create a new check run. -
      • -
    • - rerequested - Occurs when someone requests to - re-run the entire check suite from the pull request UI. When - you receive the rerequested action events, you'll - need to - create a new check run. See "About status checks" for more details about the GitHub UI. -
      • -
    -
    check_suiteobject - The - check_suite. -
    check_suite[head_branch]stringThe head branch name the changes are on.
    check_suite[head_sha]stringThe SHA of the most recent commit for this check suite.
    check_suite[status]string - The summary status for all check runs that are part of the check - suite. Can be queued, requested, - in_progress, or completed. -
    check_suite[conclusion]string - The summary conclusion for all check runs that are part of the - check suite. Can be one of success, - failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_suite[url]stringURL that points to the check suite API resource.
    check_suite[pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    repositoryobject - The - repository +
    +

    + deployment +

    +
    +
    + A deployment is created. The type of activity is specified in the + action property of the payload object. For more + information, see the "deployment" REST API. +
    +

    Availability for deployment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Deployments permission
      • +
    +

    Webhook payload object for deployment

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    deployment object
    +
    +
    + The + deployment. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "deployment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "id": 2, "node_id": "MDEwOkRlcGxveW1lbnQy", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "ref": "master", + "task": "deploy", "payload": {}, "original_environment": + "production", "environment": "production", "description": null, + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:20Z", "updated_at": "2019-05-15T19:38:20Z", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + deployment_status +

    +
    +
    + A deployment is created. The type of activity is specified in the + action property of the payload object. For more + information, see the "deployments" REST API. +
    +

    Availability for deployment_status

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Deployments permission
      • +
    +

    Webhook payload object for deployment_status

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "check_suite": {
-    "id": 9,
-    "node_id": "MDEwOkNoZWNrU3VpdGU5",
-    "head_branch": "changes",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "status": "completed",
-    "conclusion": "success",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-    "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:39:09Z",
-    "latest_check_runs_count": 1,
-    "check_runs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs",
-    "head_commit": {
-      "id": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
-      "message": "Update README.md",
-      "timestamp": "2019-05-15T19:38:01Z",
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@Octocoders.io"
-      },
-      "committer": {
-        "name": "Codertocat",
-        "email": "Codertocat@Octocoders.io"
-      }
-    }
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    + deployment_status object +
    +
    +
    + The + deployment status. +
    +
    +
    +
    +
    +
    +
    + deployment_status["state"] + string +
    +
    +
    + The new state. Can be pending, + success, failure, or + error. +
    +
    +
    +
    +
    +
    +
    + deployment_status["target_url"] + string +
    +
    +
    The optional link added to the status.
    +
    +
    +
    +
    +
    +
    + deployment_status["description"] + string +
    +
    +
    + The optional human-readable description added to the + status. +
    +
    +
    +
    +
    +
    +
    deployment object
    +
    +
    + The + deployment + that this status is associated with. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "deployment_status": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2", + "id": 2, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy", "state": + "success", "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "description": "", + "environment": "production", "target_url": "", "created_at": + "2019-05-15T19:38:21Z", "updated_at": "2019-05-15T19:38:21Z", + "deployment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "deployment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "id": 2, "node_id": "MDEwOkRlcGxveW1lbnQy", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "ref": "master", + "task": "deploy", "payload": {}, "original_environment": + "production", "environment": "production", "description": null, + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:20Z", "updated_at": "2019-05-15T19:38:21Z", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - code_scanning_alert -

    -

    - Activity related to code scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see "About code scanning." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - created, reopened_by_user, - closed_by_user, fixed, - appeared_in_branch, or reopened. -
    alertobjectThe code scanning alert involved in the event.
    refstring - 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. -
    commit_oidstring - 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. -
    repositoryobject - The - repository +
    +

    + enterprise +

    +
    +
    + A site or repository administrator enables or disables anonymous + Git read access. See "Allowing admins to enable anonymous Git read access to public + repositories" for more details. This event is not available in the Events + API. +
    +

    Availability for enterprise

    +
      +
    • + GitHub Enterprise webhooks. For more information, "Global webhooks." +
      • +
    +

    Webhook payload object for enterprise

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be + anonymous_access_enabled or + anonymous_access_disabled. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "anonymous_access_enabled", "sender": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://avatars.octocoders.github.io/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": true } } +
    +
    + +
    +
    +

    + fork +

    +
    +
    + A user forks a repository. For more information, see the "forks" REST API. +
    +

    Availability for fork

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for fork

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is reopened_by_user or - closed_by_user, the sender object will - be the user that triggered the event. The - sender object is github-enterprise for - all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 10,
-    "created_at": "2020-07-22T14:06:31Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
-    "instances": [
-      {
-        "ref": "refs/heads/main",
-        "analysis_key": ".github/workflows/workflow.yml:upload",
-        "environment": "{}",
-        "state": "open"
-      }
-    ],
-    "state": "open",
-    "dismissed_by": null,
-    "dismissed_at": null,
-    "dismissed_reason": null,
-    "rule": {
-      "id": "Style/FrozenStringLiteralComment",
-      "severity": "note",
-      "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default."
-    },
-    "tool": {
-      "name": "Rubocop",
-      "version": null
-    }
-  },
-  "ref": "refs/heads/main",
-  "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    forkee object
    +
    +
    + The created + repository + resource. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "forkee": { "id": 120, "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=", + "name": "Hello-World", "full_name": "Octocoders/Hello-World", + "private": false, "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master", "public": true }, "repository": { + "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "installation": { + "id": 5, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } + } +
    + -

    - - commit_comment -

    -

    - A commit comment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "commit comment" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    commentobject - The - commit comment +
    +

    + github_app_authorization +

    +
    +
    + When someone revokes their authorization of a GitHub App, this + event occurs. A GitHub App receives this webhook by default and + cannot unsubscribe from this event.Anyone 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 + user-to-server requests, which require GitHub App authorization, + see "Identifying and authorizing users for GitHub Apps." +
    +

    Availability for github_app_authorization

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for github_app_authorization +

    +
    +
    + - resource. - - - - - - + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be revoked. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "revoked", "sender": { "login": "octocat", "id": 1, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": false } } +
    +
    + +
    +
    +

    + gollum +

    +
    +
    + A wiki page is created or updated. For more information, see "About wikis." +
    +

    Availability for gollum

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for gollum

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    pages array
    +
    +
    The pages that were updated.
    +
    +
    +
    +
    +
    +
    + pages[][page_name] string +
    +
    +
    The name of the page.
    +
    +
    +
    +
    +
    +
    + pages[][title] string +
    +
    +
    The current page title.
    +
    +
    +
    +
    +
    +
    + pages[][action] string +
    +
    +
    + The action that was performed on the page. Can be + created or edited. +
    +
    +
    +
    +
    +
    +
    pages[][sha] string
    +
    +
    The latest commit SHA of the page.
    +
    +
    +
    +
    +
    +
    + pages[][html_url] string +
    +
    +
    Points to the HTML wiki page.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "pages": [ { "page_name": "Home", "title": "Home", "summary": + null, "action": "edited", "sha": + "4bbb6df16cb5ce1818602bf634e94ebdac7ae385", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home" } + ], "repository": { "id": 122, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjI=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "owner": { "login": "Codertocat", "id": + 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://avatars.octocoders.github.io/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "private": false, + "html_url": "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-10-04T18:29:19Z", "updated_at": + "2018-10-04T18:29:21Z", "pushed_at": "2018-10-04T18:29:59Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 0, "license": null, + "forks": 0, "open_issues": 0, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "rachmari", "id": 3, "node_id": + "MDQ6VXNlcjM=", "avatar_url": + "https://avatars.octocoders.github.io/u/3?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/rachmari", + "html_url": "https://octocoders.github.io/rachmari", + "followers_url": + "https://octocoders.github.io/api/v3/users/rachmari/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/rachmari/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/rachmari/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/rachmari/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/rachmari/received_events", + "type": "User", "site_admin": true } } +
    +
    +
    +
    +
    +

    + installation +

    +
    +
    + Activity related to a GitHub App installation. The type of + activity is specified in the action property of the + payload object. For more information, see the "GitHub App installation" REST API. +
    +

    Availability for installation

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for installation

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2",
-    "id": 2,
-    "node_id": "MDEzOkNvbW1pdENvbW1lbnQy",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "position": null,
-    "line": null,
-    "path": null,
-    "commit_id": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "created_at": "2019-05-15T19:38:09Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "author_association": "OWNER",
-    "body": "This is a really good change! :+1:"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + created - Someone installs a GitHub + App. +
      • +
    • + deleted - Someone uninstalls a + GitHub App +
      • +
    • + suspend - Someone suspends a GitHub + App installation. +
      • +
    • + unsuspend - Someone unsuspends a + GitHub App installation. +
      • +
    • + new_permissions_accepted - Someone + accepts new permissions for a GitHub App + installation. When a GitHub App owner requests + new permissions, the person who installed the + GitHub App must accept the new permissions + request. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repositories array
    +
    +
    + An array of repository objects that the installation + can access. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    The GitHub App installation.
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "deleted", "installation": { "id": 5, "account": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?", + "gravatar_id": "", "url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat", + "followers_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers", + "following_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs", + "repos_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos", + "events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repository_selection": + "selected", "access_tokens_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens", + "repositories_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5", + "app_id": 2, "target_id": 4, "target_type": "User", "permissions": + { "administration": "write", "checks": "write", "contents": + "write", "deployments": "write", "issues": "write", "pages": + "write", "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "statuses": "write", + "repository_pre_receive_hooks": "write", "metadata": "read", + "vulnerability_alerts": "read" }, "events": [ "check_run", + "check_suite", "commit_comment", "create", "delete", "deployment", + "deployment_status", "fork", "gollum", "issues", "issue_comment", + "label", "member", "membership", "milestone", "organization", + "page_build", "project", "project_card", "project_column", + "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ], "created_at": + "2019-05-15T19:37:38.000Z", "updated_at": + "2019-05-15T19:37:38.000Z", "single_file_name": null }, + "enterprise": { "id": 1, "slug": "github", "name": "GitHub", + "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github", + "created_at": "2019-05-14T19:31:12Z", "updated_at": + "2019-05-14T19:31:12Z" }, "sender": { "login": "Codertocat", "id": + 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?", + "gravatar_id": "", "url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat", + "followers_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers", + "following_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs", + "repos_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos", + "events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    + -

    - - create -

    -

    - A Git branch or tag is created. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you create more than three tags at once. -

    +
    +

    + installation_repositories +

    +
    +
    + Activity related to repositories being added to a GitHub App + installation. The type of activity is specified in the + action property of the payload object. For more + information, see the "GitHub App installation" REST API. +
    +

    Availability for installation_repositories

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for installation_repositories +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be either + added or removed. +
    +
    +
    +
    +
    +
    +
    + repository_selection string +
    +
    +
    + The choice of repositories the installation is on. + Can be either selected or + all. +
    +
    +
    +
    +
    +
    +
    + repositories_added array +
    +
    +
    + An array of repository objects, which were added to + the installation. +
    +
    +
    +
    +
    +
    +
    + repositories_removed array +
    +
    +
    + An array of repository objects, which were removed + from the installation. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    The GitHub App installation.
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added", "installation": { "id": 5, "account": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repository_selection": + "selected", "access_tokens_url": + "https://octocoders.github.io/api/v3/app/installations/5/access_tokens", + "repositories_url": + "https://octocoders.github.io/api/v3/installation/repositories", + "html_url": + "https://octocoders.github.io/settings/installations/5", "app_id": + 2, "target_id": 4, "target_type": "User", "permissions": { + "administration": "write", "repository_pre_receive_hooks": + "write", "statuses": "write", "repository_projects": "write", + "repository_hooks": "write", "pull_requests": "write", "pages": + "write", "issues": "write", "deployments": "write", "contents": + "write", "checks": "write", "vulnerability_alerts": "read", + "metadata": "read" }, "events": [ "check_run", "check_suite", + "commit_comment", "create", "delete", "deployment", + "deployment_status", "fork", "gollum", "issues", "issue_comment", + "label", "member", "membership", "milestone", "organization", + "page_build", "project", "project_card", "project_column", + "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ], "created_at": 1557949058, + "updated_at": 1557949058, "single_file_name": null }, + "repository_selection": "selected", "repositories_added": [ { + "id": 119, "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=", "name": "Space", + "full_name": "Codertocat/Space", "private": false } ], + "repositories_removed": [], "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    refstring - The - git ref +
    +

    + issue_comment +

    +
    +
    + Activity related to an issue or pull request comment. The type of + activity is specified in the action property of the + payload object. For more information, see the "issue comments" REST API. +
    +

    Availability for issue_comment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Issues permission
      • +
    +

    Webhook payload object for issue_comment

    +
    +
    + - resource. - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ref_typestring - The type of Git ref object created in the repository. Can be - either branch or tag. -
    master_branchstring - The name of the repository's default branch (usually - main). -
    descriptionstringThe repository's current description.
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the comment. Can be + one of created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    issue object
    +
    +
    + The + issue + the comment belongs to. +
    +
    +
    +
    +
    +
    +
    comment object
    +
    +
    + The + comment + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "issue": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1", + "id": 10, "node_id": "MDU6SXNzdWUxMA==", "number": 1, "title": + "Spelling error in the README file", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "labels": [ { "id": 941, + "node_id": "MDU6TGFiZWw5NDE=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", "color": "d73a4a", "default": true } ], "state": + "open", "locked": false, "assignee": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "assignees": [ { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } ], "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 1, + "closed_issues": 0, "state": "closed", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:53Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": + "2019-05-15T19:37:53Z" }, "comments": 0, "created_at": + "2019-05-15T19:37:53Z", "updated_at": "2019-05-15T19:37:55Z", + "closed_at": null, "author_association": "OWNER", "body": "It + looks like you accidently spelled 'commit' with two 't's." }, + "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "id": 2, "node_id": "MDEyOklzc3VlQ29tbWVudDI=", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:37:55Z", "updated_at": "2019-05-15T19:37:55Z", + "author_association": "OWNER", "body": "You are totally right! + I'll get this fixed right away." }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 1, + "license": null, "forks": 0, "open_issues": 1, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + issues +

    +
    +
    + Activity related to an issue. The type of activity is specified in + the action property of the payload object. For more + information, see the "issues" REST API. +
    +

    Availability for issues

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Issues permission
      • +
    +

    Webhook payload object for issues

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + opened, edited, + deleted, pinned, + unpinned, closed, + reopened, assigned, + unassigned, labeled, + unlabeled, locked, + unlocked, transferred, + milestoned, or + demilestoned. +
    +
    +
    +
    +
    +
    +
    issue object
    +
    +
    + The + issue + itself. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the issue if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from] string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    assignee object
    +
    +
    + The optional user who was assigned or unassigned + from the issue. +
    +
    +
    +
    +
    +
    +
    label object
    +
    +
    + The optional label that was added or removed from + the issue. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "edited", "issue": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1", + "id": 10, "node_id": "MDU6SXNzdWUxMA==", "number": 1, "title": + "Spelling error in the README file", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "labels": [ { "id": 941, + "node_id": "MDU6TGFiZWw5NDE=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", "color": "d73a4a", "default": true } ], "state": + "open", "locked": false, "assignee": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "assignees": [ { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } ], "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 1, + "closed_issues": 0, "state": "closed", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:53Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": + "2019-05-15T19:37:53Z" }, "comments": 0, "created_at": + "2019-05-15T19:37:53Z", "updated_at": "2019-05-15T19:37:54Z", + "closed_at": null, "author_association": "OWNER", "body": "It + looks like you accidently spelled 'commit' with two 't's." }, + "changes": {}, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 1, + "license": null, "forks": 0, "open_issues": 1, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + label +

    +
    +
    + Activity related to a label. The type of activity is specified in + the action property of the payload object. For more + information, see the "labels" REST API. +
    +

    Availability for label

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object for label

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "master_branch": "master",
-  "description": null,
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:22Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be + created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    label object
    +
    +
    The label that was added.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the label if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[color][from] string +
    +
    +
    + The previous version of the color if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "deleted", "label": { "id": 965, "node_id": + "MDU6TGFiZWw5NjU=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix", + "name": ":bug: Bugfix", "color": "cceeaa", "default": false }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - delete -

    -

    - A Git branch or tag is deleted. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you delete more than three tags at once. -

    +
    +

    + member +

    +
    +
    + Activity related to repository collaborators. The type of activity + is specified in the action property of the payload + object. For more information, see the "collaborators" REST API. +
    +

    Availability for member

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for member

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + added - A user accepts an + invitation to a repository. +
      • +
    • + removed - A user is removed as a + collaborator in a repository. +
      • +
    • + edited - A user's collaborator + permissions have changed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    member object
    +
    +
    + The + user + that was added. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the collaborator permissions if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[old_permission][from] + string +
    +
    +
    + The previous permissions of the collaborator if the + action was edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added", "member": { "login": "Hacktocat", "id": 5, + "node_id": "MDQ6VXNlcjU=", "avatar_url": + "https://octocoders.github.io/avatars/u/5?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Hacktocat", + "html_url": "https://octocoders.github.io/Hacktocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/received_events", + "type": "User", "site_admin": false }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    refstring - The - git ref +
    +

    + membership +

    +
    +
    + Activity related to team membership. The type of activity is + specified in the action property of the payload + object. For more information, see the "team members" REST API. +
    +

    Availability for membership

    +
      +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for membership

    +
    +
    + - resource. - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ref_typestring - The type of Git ref object deleted in the repository. Can be - either branch or tag. -
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be + added or removed. +
    +
    +
    +
    +
    +
    +
    scope string
    +
    +
    + The scope of the membership. Currently, can only be + team. +
    +
    +
    +
    +
    +
    +
    member object
    +
    +
    + The + user + that was added or removed. +
    +
    +
    +
    +
    +
    +
    team object
    +
    +
    + The + team + for the membership. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "removed", "scope": "team", "member": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "sender": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "team": { "name": "github", + "id": 3, "node_id": "MDQ6VGVhbTM=", "slug": "github", + "description": "Open-source team", "privacy": "secret", "url": + "https://octocoders.github.io/api/v3/teams/3", "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "organization": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" } + } +
    +
    + +
    +
    +

    + meta +

    +
    +
    + The webhook this event is configured on was deleted. This event + will only listen for changes to the particular hook the event is + installed on. Therefore, it must be selected for each hook that + you'd like to receive meta events for. +
    +

    Availability for meta

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for meta

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be deleted. +
    +
    +
    +
    +
    +
    +
    hook_id integer
    +
    +
    The id of the modified webhook.
    +
    +
    +
    +
    +
    +
    hook object
    +
    +
    + The modified webhook. This will contain different + keys based on the type of webhook it is: repository, + organization, business, app, or GitHub Marketplace. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "deleted", "hook_id": 101047067, "hook": { "type": + "Repository", "id": 101047067, "name": "web", "active": true, + "events": [ "meta" ], "config": { "content_type": "json", + "insecure_ssl": "0", "url": "http://example.com/hook" }, + "updated_at": "2019-04-10T03:57:12Z", "created_at": + "2019-04-10T03:57:12Z" }, "repository": { "id": 135493233, + "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "owner": { + "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "private": false, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-05-30T20:18:04Z", "updated_at": + "2018-05-30T20:18:50Z", "pushed_at": "2018-05-30T20:18:48Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 1, "license": null, + "forks": 0, "open_issues": 1, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + milestone +

    +
    +
    + Activity related to milestones. The type of activity is specified + in the action property of the payload object. For + more information, see the "milestones" REST API. +
    +

    Availability for milestone

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object for milestone

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + created, closed, + opened (a closed milestone is + re-opened), edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    milestone object
    +
    +
    The milestone itself.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the milestone if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[description][from] + string +
    +
    +
    + The previous version of the description if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[due_on][from] string +
    +
    +
    + The previous version of the due date if the action + was edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from] string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "created", "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 0, + "closed_issues": 0, "state": "open", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:52Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": null }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - deploy_key -

    -

    - A deploy key is added or removed from a repository. The type of activity - is specified in the action property of the payload object. - For more information, see the "Deploy keys" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be either created or - deleted. -
    keyobject - The - deploy key +
    +

    + organization +

    +
    +
    + Activity related to an organization and its members. The type of + activity is specified in the action property of the + payload object. For more information, see the "organizations" REST API. +
    +

    Availability for organization

    +
      +
    • + GitHub Enterprise webhooks only receive created and + deleted events. For more information, "Global webhooks. +
      • +
    • + Organization webhooks only receive the deleted, + added, removed, renamed, + and invited events +
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for organization

    +
    +
    + - resource. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: + created, deleted, + renamed, member_added, + member_removed, or + member_invited. +
    +
    +
    +
    +
    +
    +
    invitation object
    +
    +
    + The invitation for the user or email if the action + is member_invited. +
    +
    +
    +
    +
    +
    +
    membership object
    +
    +
    + The membership between the user and the + organization. Not present when the action is + member_invited. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "member_added", "membership": { "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat", + "state": "active", "role": "member", "organization_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", "user": { + "login": "Hacktocat", "id": 5, "node_id": "MDQ6VXNlcjU=", + "avatar_url": "https://octocoders.github.io/avatars/u/5?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Hacktocat", "html_url": + "https://octocoders.github.io/Hacktocat", "followers_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/received_events", + "type": "User", "site_admin": false } }, "organization": { + "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    + +
    +
    +

    + package +

    +
    +
    + Activity related to GitHub Packages. The type of activity is + specified in the action property of the payload + object. For more information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. +
    +

    Availability for package

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for package

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be + published or updated. +
    +
    +
    +
    +
    +
    +
    package object
    +
    +
    Information about the package.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "package": { "id": 10696, "name": + "hello-world-npm", "namespace": "Codertocat/hello-world-npm", + "description": null, "ecosystem": "docker", "package_type": "npm", + "html_url": + "https://github.com/Codertocat/hello-world-npm/packages/10696", + "created_at": "2019-05-09T23:28:29Z", "updated_at": + "2019-05-09T23:28:29Z", "owner": { "login": "Codertocat", "id": + 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "package_version": { "id": 24147, + "version": "1.0.0", "summary": "A simple npm package to + demonstrate GitHub Packages", "name": + "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "description": "", "body": "# hello-world-npm\n\nThis is a simple + npm package that demonstrates the [Github + Packages](https://github.com/features/package).\n\n## Installation + \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = + require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n", + "body_html": "<h1>hello-world-npm</h1>\n<p>This + is a simple npm package that demonstrates the <a + href=\"https://github.com/features/package\">Github Package + Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ + npm + install</code></p>\n<h2>Usage</h2>\n<pre><code>const + myPackage = + require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>", + "release": { "url": + "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286", + "html_url": + "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0", + "id": 17264286, "tag_name": "1.0.0", "target_commitish": "master", + "name": "1.0.0", "draft": false, "author": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "prerelease": false, "created_at": + "2019-05-09T23:24:40Z", "published_at": "2019-05-09T23:26:59Z" }, + "manifest": + "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A + simple npm package to demonstrate GitHub Package + Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo + \\\"Error: no test specified\\\" \\u0026\\u0026 exit + 1\"},\"version\":\"1.0.0\"}", "html_url": + "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0", + "tag_name": "1.0.0", "target_commitish": "master", "target_oid": + "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", "draft": false, + "prerelease": false, "created_at": "2019-05-09T23:28:29Z", + "updated_at": "2019-05-09T23:28:30Z", "metadata": [], + "docker_metadata": [], "package_files": [ { "download_url": + "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream", + "id": 92167, "name": "hello-world-npm-1.0.0-npm.tgz", "sha256": + "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8", + "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb", "md5": + "56ebbd5a5a03367f62d0c732bafd3c66", "content_type": + "application/octet-stream", "state": "uploaded", "size": 654, + "created_at": "2019-05-09T23:28:30Z", "updated_at": + "2019-05-09T23:28:30Z" } ], "author": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "source_url": + "ghcr.io/Codertocat/hello-world-npm/image-1:v1", + "installation_command": "npm install @Codertocat/@1.0.0" }, + "registry": { "about_url": + "https://help.github.com/about-github-packages", "name": "GitHub + npm registry", "type": "npm", "url": + "https://npm.pkg.github.com/@Codertocat", "vendor": "GitHub Inc" } + }, "repository": { "id": 185882436, "node_id": + "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=", "name": "hello-world-npm", + "full_name": "Codertocat/hello-world-npm", "private": true, + "owner": { "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "html_url": + "https://github.com/Codertocat/hello-world-npm", "description": + null, "fork": false, "url": + "https://api.github.com/repos/Codertocat/hello-world-npm", + "forks_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/deployments", + "created_at": "2019-05-09T22:53:26Z", "updated_at": + "2019-05-09T23:24:42Z", "pushed_at": "2019-05-09T23:27:00Z", + "git_url": "git://github.com/Codertocat/hello-world-npm.git", + "ssh_url": "git@github.com:Codertocat/hello-world-npm.git", + "clone_url": "https://github.com/Codertocat/hello-world-npm.git", + "svn_url": "https://github.com/Codertocat/hello-world-npm", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + page_build +

    +
    +
    + Represents an attempted build of a GitHub Pages site, whether + successful or not. A push to a GitHub Pages enabled branch (gh-pages - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "key": {
-    "id": 100,
-    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100",
-    "title": "hey-its-a-deploy-key",
-    "verified": true,
-    "created_at": "2019-04-02T17:37:07Z",
-    "read_only": true
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    + for project pages, the default branch for user and organization + pages) triggers this event. +
    +

    Availability for page_build

    + +

    Webhook payload object for page_build

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    id integer
    +
    +
    The unique identifier of the page build.
    +
    +
    +
    +
    +
    +
    build object
    +
    +
    + The + List GitHub Pages builds + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "id": 7, "build": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7", + "status": "built", "error": { "message": null }, "pusher": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "commit": + "3648135c2986115284ae152d90459473b15fd19c", "duration": 6917, + "created_at": "2019-05-15T19:38:15Z", "updated_at": + "2019-05-15T19:38:22Z" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - deployment -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployment" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deploymentobject - The - deployment. -
    repositoryobject - The +
    +
    +

    + ping +

    +
    +
    + When you create a new webhook, we'll send you a simple + ping event to let you know you've set up the webhook + correctly. This event isn't stored so it isn't retrievable via the repositoryEvents API - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization +

    Availability for ping

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps receive a ping event with an + app_id used to register the app +
      • +
    +

    Webhook payload object for ping

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:20Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    zen string
    +
    +
    Random string of GitHub zen.
    +
    +
    +
    +
    +
    +
    hook_id integer
    +
    +
    + The ID of the webhook that triggered the ping. +
    +
    +
    +
    +
    +
    +
    hook object
    +
    + +
    +
    +
    +
    +
    +
    + hook[app_id] integer +
    +
    +
    + When you register a new GitHub App, GitHub + Enterprise Server sends a ping event to the + webhook URL you specified during + registration. The event contains the + app_id, which is required for + authenticating + an app. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "zen": "Non-blocking is better than blocking.", "hook_id": 30, + "hook": { "type": "Repository", "id": 30, "name": "web", "active": + true, "events": [ "*" ], "config": { "content_type": "json", + "url": "https://smee.io/YEbF2t8kjvPAn7Ck", "insecure_ssl": "0" }, + "updated_at": "2019-05-15T19:38:17Z", "created_at": + "2019-05-15T19:38:17Z", "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30", + "test_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test", + "ping_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings", + "last_response": { "code": null, "status": "unused", "message": + null } }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    + -

    - - deployment_status -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deployment_statusobject - The - deployment status. -
    deployment_status["state"]string - The new state. Can be pending, success, - failure, or error. -
    deployment_status["target_url"]stringThe optional link added to the status.
    deployment_status["description"]string - The optional human-readable description added to the status. -
    deploymentobject - The - deployment +
    +

    + project +

    +
    +
    + Activity related to project boards. The type of activity is + specified in the action property of the payload + object. For more information, see the "projects" REST API. +
    +

    Availability for project

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object for project

    +
    +
    + - that this status is associated with. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the project. Can be + one of created, edited, + closed, reopened, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the project if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    project object
    +
    +
    + The + project + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "project": { "owner_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "url": "https://octocoders.github.io/api/v3/projects/6", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/projects/1", + "columns_url": + "https://octocoders.github.io/api/v3/projects/6/columns", "id": 6, + "node_id": "MDc6UHJvamVjdDY=", "name": "Space 2.0", "body": + "Project tasks for a trip to Space", "number": 1, "state": "open", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:38:27Z" }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + project_card +

    +
    +
    + Activity related to cards in a project board. The type of activity + is specified in the action property of the payload + object. For more information, see the "project cards" REST API. +
    +

    Availability for project_card

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object for project_card

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed on the project card. Can be + created, edited, + moved, converted, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the project card if the action was + edited or converted. +
    +
    +
    +
    +
    +
    +
    + changes[note][from] string +
    +
    +
    + The previous version of the note if the action was + edited or converted. +
    +
    +
    +
    +
    +
    +
    after_id integer
    +
    +
    + The id of the card that this card now follows if the + action was "moved". Will be null if it + is the first card in a column. +
    +
    +
    +
    +
    +
    +
    project_card object
    +
    +
    + The + project card + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "project_card": { "url": + "https://octocoders.github.io/api/v3/projects/columns/cards/8", + "project_url": "https://octocoders.github.io/api/v3/projects/6", + "column_url": + "https://octocoders.github.io/api/v3/projects/columns/8", + "column_id": 8, "id": 8, "node_id": "MDExOlByb2plY3RDYXJkOA==", + "note": "Work that can be completed in one hour or less.", + "archived": false, "creator": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:39:01Z", "updated_at": "2019-05-15T19:39:01Z" }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + project_column +

    +
    +
    + Activity related to columns in a project board. The type of + activity is specified in the action property of the + payload object. For more information, see the "project columns" REST API. +
    +

    Availability for project_column

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object for project_column

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "deployment_status": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2",
-    "id": 2,
-    "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy",
-    "state": "success",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "description": "",
-    "environment": "production",
-    "target_url": "",
-    "created_at": "2019-05-15T19:38:21Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "deployment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the project column. + Can be one of created, + edited, moved or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the project column if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    after_id integer
    +
    +
    + The id of the column that this column now follows if + the action was "moved". Will be null if + it is the first column in a project. +
    +
    +
    +
    +
    +
    +
    + project_column object +
    +
    +
    + The + project column + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "created", "project_column": { "url": + "https://octocoders.github.io/api/v3/projects/columns/8", + "project_url": "https://octocoders.github.io/api/v3/projects/6", + "cards_url": + "https://octocoders.github.io/api/v3/projects/columns/8/cards", + "id": 8, "node_id": "MDEzOlByb2plY3RDb2x1bW44", "name": "Small + bugfixes", "created_at": "2019-05-15T19:39:01Z", "updated_at": + "2019-05-15T19:39:01Z" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - enterprise -

    -

    - A site or repository administrator enables or disables anonymous Git - read access. See "Allowing admins to enable anonymous Git read access to public - repositories" for more details. This event is not available in the Events API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be - anonymous_access_enabled or - anonymous_access_disabled. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "anonymous_access_enabled",
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    +
    +

    + public +

    +
    +
    + When a private repository is made public. Without a doubt: the + best GitHub Enterprise Server event. +
    +

    Availability for public

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object for public

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - fork -

    -

    - A user forks a repository. For more information, see the "forks" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    forkeeobject - The created - repository +
    +

    + pull_request +

    +
    +
    + Activity related to pull requests. The type of activity is + specified in the action property of the payload + object. For more information, see the "pull requests" REST API. +
    +

    Availability for pull_request

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object for pull_request

    +
    +
    + - resource. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • assigned
      • +
    • auto_merge_disabled
      • +
    • auto_merge_enabled
      • +
    • + closed: If the action is + closed and the + merged key is false, + the pull request was closed with unmerged + commits. If the action is + closed and the + merged key is true, + the pull request was merged. +
      • +
    • converted_to_draft
      • +
    • edited
      • +
    • labeled
      • +
    • locked
      • +
    • opened
      • +
    • ready_for_review
      • +
    • reopened
      • +
    • review_request_removed
      • +
    • review_requested
      • +
    • + synchronize: Triggered when a pull + request's head branch is updated. For example, + when the head branch is updated from the base + branch, when new commits are pushed to the head + branch, or when the base branch is changed. +
      • +
    • unassigned
      • +
    • unlabeled
      • +
    • unlocked
      • +
    +
    +
    +
    +
    +
    +
    +
    number integer
    +
    +
    The pull request number.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from] string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + pull_request_review +

    +
    +
    + Activity related to pull request reviews. The type of activity is + specified in the action property of the payload + object. For more information, see the "pull request reviews" REST API. +
    +

    Availability for pull_request_review

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object for pull_request_review

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + submitted - A pull request review + is submitted into a non-pending state. +
      • +
    • + edited - The body of a review has + been edited. +
      • +
    • + dismissed - A review has been + dismissed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + the review pertains to. +
    +
    +
    +
    +
    +
    +
    review object
    +
    +
    The review that was affected.
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "submitted", "review": { "id": 2, "node_id": + "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": null, "commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "submitted_at": + "2019-05-15T19:38:08Z", "state": "commented", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2", + "pull_request_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", "_links": { "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2" + }, "pull_request": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + } } }, "pull_request": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2", + "diff_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff", + "patch_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2", + "number": 2, "state": "open", "locked": false, "title": "Update + the README with new information.", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "This is a pretty + simple change that we need to pull into master.", "created_at": + "2019-05-15T19:38:02Z", "updated_at": "2019-05-15T19:38:08Z", + "closed_at": null, "merged_at": null, "merge_commit_sha": + "e67e14475991deeb61cc1999c3bf9db333ac0d5f", "assignee": null, + "assignees": [], "requested_reviewers": [], "requested_teams": [], + "labels": [], "milestone": null, "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1", + "head": { "label": "Codertocat:changes", "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "base": { "label": + "Codertocat:master", "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2" }, + "issue": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2" + }, "comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments" + }, "review_comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments" + }, "review_comment": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}" + }, "commits": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits" + }, "statuses": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1" + } }, "author_association": "OWNER" }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + pull_request_review_comment +

    +
    +
    + Activity related to pull request review comments in the pull + request's unified diff. The type of activity is specified in the + action property of the payload object. For more + information, see the "pull request review comments" REST API. +
    +

    Availability for pull_request_review_comment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    + Webhook payload object for + pull_request_review_comment +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "forkee": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "public": true
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the comment. Can be + one of created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + the comment belongs to. +
    +
    +
    +
    +
    +
    +
    comment object
    +
    +
    + The + comment + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "action": "created", "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2", + "pull_request_review_id": 2, "id": 2, "node_id": + "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=", "diff_hunk": "@@ -1 +1 + @@\n-# Hello-World", "path": "README.md", "position": 1, + "original_position": 1, "commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "original_commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "Maybe you should + use more emoji on this line.", "created_at": + "2019-05-15T19:38:07Z", "updated_at": "2019-05-15T19:38:08Z", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2", + "pull_request_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2" + }, "pull_request": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + } } }, "pull_request": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2", + "diff_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff", + "patch_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2", + "number": 2, "state": "open", "locked": false, "title": "Update + the README with new information.", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "This is a pretty + simple change that we need to pull into master.", "created_at": + "2019-05-15T19:38:02Z", "updated_at": "2019-05-15T19:38:08Z", + "closed_at": null, "merged_at": null, "merge_commit_sha": + "e67e14475991deeb61cc1999c3bf9db333ac0d5f", "assignee": null, + "assignees": [], "requested_reviewers": [], "requested_teams": [], + "labels": [], "milestone": null, "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1", + "head": { "label": "Codertocat:changes", "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "base": { "label": + "Codertocat:master", "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2" }, + "issue": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2" + }, "comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments" + }, "review_comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments" + }, "review_comment": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}" + }, "commits": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits" + }, "statuses": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1" + } }, "author_association": "OWNER" }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - github_app_authorization -

    -

    - When someone revokes their authorization of a GitHub App, this event - occurs. A GitHub App receives this webhook by default and cannot - unsubscribe from this event. -

    -

    - Anyone 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 user-to-server requests, which require GitHub App - authorization, see "Identifying and authorizing users for GitHub Apps." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be revoked.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "revoked",
-  "sender": {
-    "login": "octocat",
-    "id": 1,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + pull_request_review_thread +

    +
    +
    + Activity related to a comment thread on a pull request being + marked as resolved or unresolved. The type of activity is + specified in the action property of the payload + object. +
    +

    Availability for pull_request_review_thread

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    + Webhook payload object for pull_request_review_thread +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + resolved - A comment thread on a + pull request was marked as resolved. +
      • +
    • + unresolved - A previously resolved + comment thread on a pull request was marked as + unresolved. +
      • +
    +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + the thread pertains to. +
    +
    +
    +
    +
    +
    +
    thread object
    +
    +
    The thread that was affected.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "resolved", "pull_request": { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118", "id": + 873298238, "node_id": "PR_kwDOEL39TM40DXk-", "html_url": + "https://github.com/octo-org/octo-repo/pull/118", "diff_url": + "https://github.com/octo-org/octo-repo/pull/118.diff", + "patch_url": + "https://github.com/octo-org/octo-repo/pull/118.patch", + "issue_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/118", + "number": 118, "state": "open", "locked": false, "title": "Create + issue-comment", "user": { "login": "octocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true }, "body": "Issue comment test", + "created_at": "2022-03-07T16:14:34Z", "updated_at": + "2022-03-21T09:21:38Z", "closed_at": null, "merged_at": null, + "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1", + "assignee": null, "assignees": [], "requested_reviewers": [], + "requested_teams": [], "labels": [], "milestone": null, "draft": + false, "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits", + "review_comments_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments", + "review_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "head": { "label": "octo-org:issue-comment", "ref": + "issue-comment", "sha": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "user": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "repo": { "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" } }, "base": { "label": + "octo-org:master", "ref": "master", "sha": + "fcaaddec44575a657bf81b049208b2ce139da3ca", "user": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "repo": { "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118" }, + "html": { "href": "https://github.com/octo-org/octo-repo/pull/118" + }, "issue": { "href": + "https://api.github.com/repos/octo-org/octo-repo/issues/118" }, + "comments": { "href": + "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments" + }, "review_comments": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments" + }, "review_comment": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}" + }, "commits": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits" + }, "statuses": { "href": + "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf" + } }, "author_association": "CONTRIBUTOR", "auto_merge": null, + "active_lock_reason": null }, "thread": { "node_id": + "PRRT_kwDOEL39TM4w7XDQ", "comments": [ { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280", + "pull_request_review_id": 901921390, "id": 820867280, "node_id": + "PRRC_kwDOEL39TM4w7XDQ", "diff_hunk": "@@ -0,0 +1 @@\n+issue + comment", "path": "issue-comment", "position": 1, + "original_position": 1, "commit_id": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "original_commit_id": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "user": { "login": + "jide2020", "id": 64502150, "node_id": "MDQ6VXNlcjY0NTAyMTUw", + "avatar_url": + "https://avatars.githubusercontent.com/u/64502150?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/jide2020", + "html_url": "https://github.com/jide2020", "followers_url": + "https://api.github.com/users/jide2020/followers", + "following_url": + "https://api.github.com/users/jide2020/following{/other_user}", + "gists_url": + "https://api.github.com/users/jide2020/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/jide2020/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/jide2020/subscriptions", + "organizations_url": "https://api.github.com/users/jide2020/orgs", + "repos_url": "https://api.github.com/users/jide2020/repos", + "events_url": + "https://api.github.com/users/jide2020/events{/privacy}", + "received_events_url": + "https://api.github.com/users/jide2020/received_events", "type": + "User", "site_admin": false }, "body": "sup", "created_at": + "2022-03-07T16:16:48Z", "updated_at": "2022-03-07T16:16:58Z", + "html_url": + "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280", + "pull_request_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118", + "author_association": "COLLABORATOR", "_links": { "self": { + "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280" + }, "html": { "href": + "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280" + }, "pull_request": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118" } }, + "reactions": { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions", + "total_count": 0, "+1": 0, "-1": 0, "laugh": 0, "hooray": 0, + "confused": 0, "heart": 0, "rocket": 0, "eyes": 0 }, "start_line": + null, "original_start_line": null, "start_side": null, "line": 1, + "original_line": 1, "side": "RIGHT" } ] }, "repository": { "id": + 280886604, "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" }, "organization": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "description": "" }, "sender": { "login": "octocat", "id": + 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true } } +
    +
    -

    - - gollum -

    -

    - A wiki page is created or updated. For more information, see "About wikis." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    pagesarrayThe pages that were updated.
    pages[][page_name]stringThe name of the page.
    pages[][title]stringThe current page title.
    pages[][action]string - The action that was performed on the page. Can be - created or edited. -
    pages[][sha]stringThe latest commit SHA of the page.
    pages[][html_url]stringPoints to the HTML wiki page.
    repositoryobject - The - repository +
    +

    + push +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you push more than three tags at once. +

    + One or more commits are pushed to a repository branch or tag. +
    +

    Availability for push

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for push

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    ref string
    +
    +
    + The full + git ref + that was pushed. Example: + refs/heads/main or + refs/tags/v3.14.1. +
    +
    +
    +
    +
    +
    +
    before string
    +
    +
    + The SHA of the most recent commit on + ref before the push. +
    +
    +
    +
    +
    +
    +
    after string
    +
    +
    + The SHA of the most recent commit on + ref after the push. +
    +
    +
    +
    +
    +
    +
    created boolean
    +
    +
    + Whether this push created the ref. +
    +
    +
    +
    +
    +
    +
    deleted boolean
    +
    +
    + Whether this push deleted the ref. +
    +
    +
    +
    +
    +
    +
    forced boolean
    +
    +
    + Whether this push was a force push of the + ref. +
    +
    +
    +
    +
    +
    +
    head_commit object
    +
    +
    + For pushes where after is or points to + a commit object, an expanded representation of that + commit. For pushes where after refers + to an annotated tag object, an expanded + representation of the commit pointed to by the + annotated tag. +
    +
    +
    +
    +
    +
    +
    compare string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    commits array
    +
    +
    + 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.) +
    +
    +
    +
    +
    +
    +
    + commits[][id] string +
    +
    +
    The SHA of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][timestamp] string +
    +
    +
    The ISO 8601 timestamp of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][message] string +
    +
    +
    The commit message.
    +
    +
    +
    +
    +
    +
    + commits[][author] object +
    +
    +
    The git author of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][author][name] + string +
    +
    +
    The git author's name.
    +
    +
    +
    +
    +
    +
    + commits[][author][email] + string +
    +
    +
    The git author's email address.
    +
    +
    +
    +
    +
    +
    commits[][url] url
    +
    +
    URL that points to the commit API resource.
    +
    +
    +
    +
    +
    +
    + commits[][distinct] boolean +
    +
    +
    + Whether this commit is distinct from any that have + been pushed before. +
    +
    +
    +
    +
    +
    +
    + commits[][added] array +
    +
    +
    + An array of files added in the commit. For extremely + large commits where GitHub Enterprise Server is + unable to calculate this list in a timely manner, + this may be empty even if files were added. +
    +
    +
    +
    +
    +
    +
    + commits[][modified] array +
    +
    +
    + An array of files modified by the commit. For + extremely large commits where GitHub Enterprise + Server is unable to calculate this list in a timely + manner, this may be empty even if files were + modified. +
    +
    +
    +
    +
    +
    +
    + commits[][removed] array +
    +
    +
    + An array of files removed in the commit. For + extremely large commits where GitHub Enterprise + Server is unable to calculate this list in a timely + manner, this may be empty even if files were + removed. +
    +
    +
    +
    +
    +
    +
    pusher object
    +
    +
    The user who pushed the commits.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "refs/tags/simple-tag", "before": + "0000000000000000000000000000000000000000", "after": + "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "created": true, + "deleted": false, "forced": false, "base_ref": null, "compare": + "https://octocoders.github.io/Codertocat/Hello-World/compare/simple-tag", + "commits": [], "head_commit": { "id": + "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "tree_id": + "4b825dc642cb6eb9a060e54bf8d69288fbee4904", "distinct": true, + "message": "Adding a .gitignore file", "timestamp": + "2019-05-15T15:20:41Z", "url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "author": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "username": "Codertocat" }, + "committer": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "username": "Codertocat" }, "added": [ + ".gitignore" ], "removed": [], "modified": [] }, "repository": { + "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": 1557949027, "updated_at": "2019-05-15T19:38:15Z", + "pushed_at": 1557949103, "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master", "stargazers": 0, "master_branch": + "master" }, "pusher": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + release +

    +
    +
    + Activity related to a release. The type of activity is specified + in the action property of the payload object. For + more information, see the "releases" REST API. +
    +

    Availability for release

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for release

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "pages": [
-    {
-      "page_name": "Home",
-      "title": "Home",
-      "summary": null,
-      "action": "edited",
-      "sha": "4bbb6df16cb5ce1818602bf634e94ebdac7ae385",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home"
-    }
-  ],
-  "repository": {
-    "id": 122,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-10-04T18:29:19Z",
-    "updated_at": "2018-10-04T18:29:21Z",
-    "pushed_at": "2018-10-04T18:29:59Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "rachmari",
-    "id": 3,
-    "node_id": "MDQ6VXNlcjM=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/3?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/rachmari",
-    "html_url": "https://octocoders.github.io/rachmari",
-    "followers_url": "https://octocoders.github.io/api/v3/users/rachmari/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/rachmari/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/rachmari/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/rachmari/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/rachmari/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + published: a release, pre-release, + or draft of a release is published +
      • +
    • + unpublished: a release or + pre-release is deleted +
      • +
    • + created: a draft is saved, or a + release or pre-release is published without + previously being saved as a draft +
      • +
    • + edited: a release, pre-release, or + draft release is edited +
      • +
    • + deleted: a release, pre-release, or + draft release is deleted +
      • +
    • + prereleased: a pre-release is + created +
      • +
    • + released: a release is published, + or a pre-release is changed to a release +
      • +
    +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    release object
    +
    +
    + The + release + object. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "action": "published", "release": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2", + "assets_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets", + "upload_url": + "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1", + "id": 2, "node_id": "MDc6UmVsZWFzZTI=", "tag_name": "0.0.1", + "target_commitish": "master", "name": null, "draft": false, + "author": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "prerelease": false, + "created_at": "2019-05-15T19:37:08Z", "published_at": + "2019-05-15T19:38:20Z", "assets": [], "tarball_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1", + "zipball_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1", + "body": null }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - installation -

    -

    - Activity related to a GitHub App installation. The type of activity is - specified in the action property of the payload object. For - more information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • created - Someone installs a GitHub App.
      • -
    • deleted - Someone uninstalls a GitHub App
      • -
    • - suspend - Someone suspends a GitHub App - installation. -
      • -
    • - unsuspend - Someone unsuspends a GitHub App - installation. -
      • -
    • - new_permissions_accepted - Someone accepts new - permissions for a GitHub App installation. When a GitHub App - owner requests new permissions, the person who installed the - GitHub App must accept the new permissions request. -
      • -
    -
    repositoriesarray - An array of repository objects that the installation can access. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-      "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-      "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-      "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-      "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-      "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "checks": "write",
-      "contents": "write",
-      "deployments": "write",
-      "issues": "write",
-      "pages": "write",
-      "pull_requests": "write",
-      "repository_hooks": "write",
-      "repository_projects": "write",
-      "statuses": "write",
-      "repository_pre_receive_hooks": "write",
-      "metadata": "read",
-      "vulnerability_alerts": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": "2019-05-15T19:37:38.000Z",
-    "updated_at": "2019-05-15T19:37:38.000Z",
-    "single_file_name": null
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-    "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-    "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-    "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-    "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + repository_dispatch +

    +
    +
    + This event occurs when a GitHub App sends a + POST request to the "Create a repository dispatch event" endpoint. +
    +

    Availability for repository_dispatch

    +
      +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for repository_dispatch

    +
    +
    + + + + + + + + + + +
    Headers
    Name, Type, Description
    +
    +
    +

    Webhook payload example

    +
    + { "action": "on-demand-test", "branch": "master", + "client_payload": { "unit": false, "integration": true }, + "repository": { "id": 17273051, "node_id": + "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", "name": "octo-repo", + "full_name": "octo-org/octo-repo", "private": true, "owner": { + "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": + "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "My first + repo on GitHub!", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2014-02-28T02:42:51Z", "updated_at": + "2018-10-10T15:58:51Z", "pushed_at": "2018-10-10T15:58:47Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 59, "stargazers_count": 0, "watchers_count": 0, "language": + "JavaScript", "has_issues": true, "has_projects": true, + "has_downloads": true, "has_wiki": true, "has_pages": false, + "forks_count": 1, "mirror_url": null, "archived": false, + "open_issues_count": 23, "license": null, "forks": 1, + "open_issues": 23, "watchers": 0, "default_branch": "master" }, + "organization": { "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars3.githubusercontent.com/u/6811672?v=4", + "description": "Working better together!" }, "sender": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "installation": { "id": 375706, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2" } + } +
    +
    -

    - - installation_repositories -

    -

    - Activity related to repositories being added to a GitHub App - installation. The type of activity is specified in the - action property of the payload object. For more - information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be either added or - removed. -
    repository_selectionstring - The choice of repositories the installation is on. Can be either - selected or all. -
    repositories_addedarray - An array of repository objects, which were added to the - installation. -
    repositories_removedarray - An array of repository objects, which were removed from the - installation. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "https://octocoders.github.io/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "https://octocoders.github.io/api/v3/installation/repositories",
-    "html_url": "https://octocoders.github.io/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "repository_pre_receive_hooks": "write",
-      "statuses": "write",
-      "repository_projects": "write",
-      "repository_hooks": "write",
-      "pull_requests": "write",
-      "pages": "write",
-      "issues": "write",
-      "deployments": "write",
-      "contents": "write",
-      "checks": "write",
-      "vulnerability_alerts": "read",
-      "metadata": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": 1557949058,
-    "updated_at": 1557949058,
-    "single_file_name": null
-  },
-  "repository_selection": "selected",
-  "repositories_added": [
-    {
-      "id": 119,
-      "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=",
-      "name": "Space",
-      "full_name": "Codertocat/Space",
-      "private": false
-    }
-  ],
-  "repositories_removed": [],
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - issue_comment -

    -

    - Activity related to an issue or pull request comment. The type of - activity is specified in the action property of the payload - object. For more information, see the "issue comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    issueobject - The - issue - the comment belongs to. -
    commentobject - The - comment - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "id": 2,
-    "node_id": "MDEyOklzc3VlQ29tbWVudDI=",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:37:55Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "author_association": "OWNER",
-    "body": "You are totally right! I'll get this fixed right away."
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - issues -

    -

    - Activity related to an issue. The type of activity is specified in the - action property of the payload object. For more - information, see the "issues" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of opened, - edited, deleted, pinned, - unpinned, closed, reopened, - assigned, unassigned, - labeled, unlabeled, locked, - unlocked, transferred, - milestoned, or demilestoned. -
    issueobject - The - issue - itself. -
    changesobject - The changes to the issue if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    assigneeobject - The optional user who was assigned or unassigned from the issue. -
    labelobject - The optional label that was added or removed from the issue. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example when someone edits an issue -

    -
    - 
    {
-  "action": "edited",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:54Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "changes": {},
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - label -

    -

    - Activity related to a label. The type of activity is specified in the - action property of the payload object. For more - information, see the "labels" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be created, - edited, or deleted. -
    labelobjectThe label that was added.
    changesobject - The changes to the label if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[color][from]string - The previous version of the color if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "label": {
-    "id": 965,
-    "node_id": "MDU6TGFiZWw5NjU=",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix",
-    "name": ":bug: Bugfix",
-    "color": "cceeaa",
-    "default": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - member -

    -

    - Activity related to repository collaborators. The type of activity is - specified in the action property of the payload object. For - more information, see the "collaborators" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - added - A user accepts an invitation to a - repository. -
      • -
    • - removed - A user is removed as a collaborator in - a repository. -
      • -
    • - edited - A user's collaborator permissions have - changed. -
      • -
    -
    memberobject - The - user - that was added. -
    changesobject - The changes to the collaborator permissions if the action was - edited. -
    changes[old_permission][from]string - The previous permissions of the collaborator if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "member": {
-    "login": "Hacktocat",
-    "id": 5,
-    "node_id": "MDQ6VXNlcjU=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-    "html_url": "https://octocoders.github.io/Hacktocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - membership -

    -

    - Activity related to team membership. The type of activity is specified - in the action property of the payload object. For more - information, see the "team members" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be added or - removed. -
    scopestring - The scope of the membership. Currently, can only be - team. -
    memberobject - The - user - that was added or removed. -
    teamobject - The - team - for the membership. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "removed",
-  "scope": "team",
-  "member": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  }
-}
-
    -
    -

    - - meta -

    -

    - The webhook this event is configured on was deleted. This event will - only listen for changes to the particular hook the event is installed - on. Therefore, it must be selected for each hook that you'd like to - receive meta events for. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be deleted.
    hook_idintegerThe id of the modified webhook.
    hookobject - The modified webhook. This will contain different keys based on - the type of webhook it is: repository, organization, business, - app, or GitHub Marketplace. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "hook_id": 101047067,
-  "hook": {
-    "type": "Repository",
-    "id": 101047067,
-    "name": "web",
-    "active": true,
-    "events": [
-      "meta"
-    ],
-    "config": {
-      "content_type": "json",
-      "insecure_ssl": "0",
-      "url": "http://example.com/hook"
-    },
-    "updated_at": "2019-04-10T03:57:12Z",
-    "created_at": "2019-04-10T03:57:12Z"
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - milestone -

    -

    - Activity related to milestones. The type of activity is specified in the - action property of the payload object. For more - information, see the "milestones" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - closed, opened (a closed milestone is - re-opened), edited, or deleted. -
    milestoneobjectThe milestone itself.
    changesobject - The changes to the milestone if the action was - edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[due_on][from]string - The previous version of the due date if the action was - edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "milestone": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-    "id": 2,
-    "node_id": "MDk6TWlsZXN0b25lMg==",
-    "number": 1,
-    "title": "v1.0",
-    "description": "Add new space flight simulator",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "open_issues": 0,
-    "closed_issues": 0,
-    "state": "open",
-    "created_at": "2019-05-15T19:37:52Z",
-    "updated_at": "2019-05-15T19:37:52Z",
-    "due_on": "2019-05-23T00:00:00Z",
-    "closed_at": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - organization -

    -

    - Activity related to an organization and its members. The type of - activity is specified in the action property of the payload - object. For more information, see the "organizations" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: - created, deleted, renamed, - member_added, member_removed, or - member_invited. -
    invitationobject - The invitation for the user or email if the action is - member_invited. -
    membershipobject - The membership between the user and the organization. Not present - when the action is member_invited. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "member_added",
-  "membership": {
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat",
-    "state": "active",
-    "role": "member",
-    "organization_url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "user": {
-      "login": "Hacktocat",
-      "id": 5,
-      "node_id": "MDQ6VXNlcjU=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-      "html_url": "https://octocoders.github.io/Hacktocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-      "type": "User",
-      "site_admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - package -

    -

    - Activity related to GitHub Packages. The type of activity is specified - in the action property of the payload object. For more - information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be published or - updated. -
    packageobjectInformation about the package.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "package": {
-    "id": 10696,
-    "name": "hello-world-npm",
-    "namespace": "Codertocat/hello-world-npm",
-    "description": null,
-    "ecosystem": "docker",
-    "package_type": "npm",
-    "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696",
-    "created_at": "2019-05-09T23:28:29Z",
-    "updated_at": "2019-05-09T23:28:29Z",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "package_version": {
-      "id": 24147,
-      "version": "1.0.0",
-      "summary": "A simple npm package to demonstrate GitHub Packages",
-      "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498",
-      "description": "",
-      "body": "# hello-world-npm\n\nThis is a simple npm package that demonstrates the [Github Packages](https://github.com/features/package).\n\n## Installation \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n",
-      "body_html": "<h1>hello-world-npm</h1>\n<p>This is a simple npm package that demonstrates the <a href=\"https://github.com/features/package\">Github Package Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ npm install</code></p>\n<h2>Usage</h2>\n<pre><code>const myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>",
-      "release": {
-        "url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286",
-        "html_url": "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0",
-        "id": 17264286,
-        "tag_name": "1.0.0",
-        "target_commitish": "master",
-        "name": "1.0.0",
-        "draft": false,
-        "author": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "prerelease": false,
-        "created_at": "2019-05-09T23:24:40Z",
-        "published_at": "2019-05-09T23:26:59Z"
-      },
-      "manifest": "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A simple npm package to demonstrate GitHub Package Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo \\\"Error: no test specified\\\" \\u0026\\u0026 exit 1\"},\"version\":\"1.0.0\"}",
-      "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0",
-      "tag_name": "1.0.0",
-      "target_commitish": "master",
-      "target_oid": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b",
-      "draft": false,
-      "prerelease": false,
-      "created_at": "2019-05-09T23:28:29Z",
-      "updated_at": "2019-05-09T23:28:30Z",
-      "metadata": [],
-      "docker_metadata": [],
-      "package_files": [
-        {
-          "download_url": "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream",
-          "id": 92167,
-          "name": "hello-world-npm-1.0.0-npm.tgz",
-          "sha256": "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8",
-          "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb",
-          "md5": "56ebbd5a5a03367f62d0c732bafd3c66",
-          "content_type": "application/octet-stream",
-          "state": "uploaded",
-          "size": 654,
-          "created_at": "2019-05-09T23:28:30Z",
-          "updated_at": "2019-05-09T23:28:30Z"
-        }
-      ],
-      "author": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "source_url": "ghcr.io/Codertocat/hello-world-npm/image-1:v1",
-      "installation_command": "npm install @Codertocat/@1.0.0"
-    },
-    "registry": {
-      "about_url": "https://help.github.com/about-github-packages",
-      "name": "GitHub npm registry",
-      "type": "npm",
-      "url": "https://npm.pkg.github.com/@Codertocat",
-      "vendor": "GitHub Inc"
-    }
-  },
-  "repository": {
-    "id": 185882436,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=",
-    "name": "hello-world-npm",
-    "full_name": "Codertocat/hello-world-npm",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/hello-world-npm",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world-npm",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments",
-    "created_at": "2019-05-09T22:53:26Z",
-    "updated_at": "2019-05-09T23:24:42Z",
-    "pushed_at": "2019-05-09T23:27:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world-npm.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world-npm.git",
-    "clone_url": "https://github.com/Codertocat/hello-world-npm.git",
-    "svn_url": "https://github.com/Codertocat/hello-world-npm",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - page_build -

    -

    - Represents an attempted build of a GitHub Pages site, whether successful - or not. A push to a GitHub Pages enabled branch (gh-pages - for project pages, the default branch for user and organization pages) - triggers this event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    idintegerThe unique identifier of the page build.
    buildobject - The - List GitHub Pages builds - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 7,
-  "build": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7",
-    "status": "built",
-    "error": {
-      "message": null
-    },
-    "pusher": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "commit": "3648135c2986115284ae152d90459473b15fd19c",
-    "duration": 6917,
-    "created_at": "2019-05-15T19:38:15Z",
-    "updated_at": "2019-05-15T19:38:22Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - ping -

    -

    - When you create a new webhook, we'll send you a simple - ping event to let you know you've set up the webhook - correctly. This event isn't stored so it isn't retrievable via the - Events API - endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    zenstringRandom string of GitHub zen.
    hook_idintegerThe ID of the webhook that triggered the ping.
    hookobject - The - webhook configuration. -
    hook[app_id]integer - When you register a new GitHub App, GitHub Enterprise Server sends - a ping event to the webhook URL you specified - during registration. The event contains the app_id, - which is required for - authenticating - an app. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "zen": "Non-blocking is better than blocking.",
-  "hook_id": 30,
-  "hook": {
-    "type": "Repository",
-    "id": 30,
-    "name": "web",
-    "active": true,
-    "events": [
-      "*"
-    ],
-    "config": {
-      "content_type": "json",
-      "url": "https://smee.io/YEbF2t8kjvPAn7Ck",
-      "insecure_ssl": "0"
-    },
-    "updated_at": "2019-05-15T19:38:17Z",
-    "created_at": "2019-05-15T19:38:17Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30",
-    "test_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test",
-    "ping_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings",
-    "last_response": {
-      "code": null,
-      "status": "unused",
-      "message": null
-    }
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - project -

    -

    - Activity related to project boards. The type of activity is specified in - the action property of the payload object. For more - information, see the "projects" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project. Can be one of - created, edited, closed, - reopened, or deleted. -
    changesobject - The changes to the project if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    projectobject - The - project - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project": {
-    "owner_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "url": "https://octocoders.github.io/api/v3/projects/6",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/projects/1",
-    "columns_url": "https://octocoders.github.io/api/v3/projects/6/columns",
-    "id": 6,
-    "node_id": "MDc6UHJvamVjdDY=",
-    "name": "Space 2.0",
-    "body": "Project tasks for a trip to Space",
-    "number": 1,
-    "state": "open",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:38:27Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - project_card -

    -

    - Activity related to cards in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project cards" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed on the project card. Can be - created, edited, moved, - converted, or deleted. -
    changesobject - The changes to the project card if the action was - edited or converted. -
    changes[note][from]string - The previous version of the note if the action was - edited or converted. -
    after_idinteger - The id of the card that this card now follows if the action was - "moved". Will be null if it is the first card in a - column. -
    project_cardobject - The - project card - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_card": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/cards/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "column_url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "column_id": 8,
-    "id": 8,
-    "node_id": "MDExOlByb2plY3RDYXJkOA==",
-    "note": "Work that can be completed in one hour or less.",
-    "archived": false,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - project_column -

    -

    - Activity related to columns in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project columns" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project column. Can be one of - created, edited, moved or - deleted. -
    changesobject - The changes to the project column if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    after_idinteger - The id of the column that this column now follows if the action - was "moved". Will be null if it is the first column - in a project. -
    project_columnobject - The - project column - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_column": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "cards_url": "https://octocoders.github.io/api/v3/projects/columns/8/cards",
-    "id": 8,
-    "node_id": "MDEzOlByb2plY3RDb2x1bW44",
-    "name": "Small bugfixes",
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - public -

    -

    - When a private repository is made public. Without a doubt: the best - GitHub Enterprise Server event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request -

    -

    - Activity related to pull requests. The type of activity is specified in - the action property of the payload object. For more - information, see the "pull requests" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • assigned
      • -
    • auto_merge_disabled
      • -
    • auto_merge_enabled
      • -
    • - closed: If the action is closed and - the merged key is false, the pull - request was closed with unmerged commits. If the action is - closed and the merged key is - true, the pull request was merged. -
      • -
    • converted_to_draft
      • -
    • edited
      • -
    • labeled
      • -
    • locked
      • -
    • opened
      • -
    • ready_for_review
      • -
    • reopened
      • -
    • review_request_removed
      • -
    • review_requested
      • -
    • - synchronize: Triggered when a pull request's head - branch is updated. For example, when the head branch is - updated from the base branch, when new commits are pushed to - the head branch, or when the base branch is changed. -
      • -
    • unassigned
      • -
    • unlabeled
      • -
    • unlocked
      • -
    -
    numberintegerThe pull request number.
    changesobject - The changes to the comment if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -

    - Deliveries for review_requested and - review_request_removed events will have an additional field - called requested_reviewer. -

    -
    - 
    {
-  "action": "opened",
-  "number": 2,
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:02Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": null,
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER",
-    "draft": false,
-    "merged": false,
-    "mergeable": null,
-    "rebaseable": null,
-    "mergeable_state": "unknown",
-    "merged_by": null,
-    "comments": 0,
-    "review_comments": 0,
-    "maintainer_can_modify": false,
-    "commits": 1,
-    "additions": 1,
-    "deletions": 1,
-    "changed_files": 1
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review -

    -

    - Activity related to pull request reviews. The type of activity is - specified in the action property of the payload object. For - more information, see the "pull request reviews" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - submitted - A pull request review is submitted - into a non-pending state. -
      • -
    • - edited - The body of a review has been edited. -
      • -
    • dismissed - A review has been dismissed.
      • -
    -
    pull_requestobject - The - pull request - the review pertains to. -
    reviewobjectThe review that was affected.
    changes[body][from]string - The previous version of the body if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "submitted",
-  "review": {
-    "id": 2,
-    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": null,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "submitted_at": "2019-05-15T19:38:08Z",
-    "state": "commented",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review_comment -

    -

    - Activity related to pull request review comments in the pull request's - unified diff. The type of activity is specified in the - action property of the payload object. For more - information, see the "pull request review comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request - the comment belongs to. -
    commentobject - The - comment - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2",
-    "pull_request_review_id": 2,
-    "id": 2,
-    "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=",
-    "diff_hunk": "@@ -1 +1 @@\n-# Hello-World",
-    "path": "README.md",
-    "position": 1,
-    "original_position": 1,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "original_commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "Maybe you should use more emoji on this line.",
-    "created_at": "2019-05-15T19:38:07Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review_thread -

    -

    - Activity related to a comment thread on a pull request being marked as - resolved or unresolved. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - resolved - A comment thread on a pull request was - marked as resolved. -
      • -
    • - unresolved - A previously resolved comment thread - on a pull request was marked as unresolved. -
      • -
    -
    pull_requestobject - The - pull request - the thread pertains to. -
    threadobjectThe thread that was affected.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "resolved",
-  "pull_request": {
-    "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-    "id": 873298238,
-    "node_id": "PR_kwDOEL39TM40DXk-",
-    "html_url": "https://github.com/octo-org/octo-repo/pull/118",
-    "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff",
-    "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch",
-    "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118",
-    "number": 118,
-    "state": "open",
-    "locked": false,
-    "title": "Create issue-comment",
-    "user": {
-      "login": "octocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "body": "Issue comment test",
-    "created_at": "2022-03-07T16:14:34Z",
-    "updated_at": "2022-03-21T09:21:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "draft": false,
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits",
-    "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments",
-    "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-    "head": {
-      "label": "octo-org:issue-comment",
-      "ref": "issue-comment",
-      "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "octo-org:master",
-      "ref": "master",
-      "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-      },
-      "html": {
-        "href": "https://github.com/octo-org/octo-repo/pull/118"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf"
-      }
-    },
-    "author_association": "CONTRIBUTOR",
-    "auto_merge": null,
-    "active_lock_reason": null
-  },
-  "thread": {
-    "node_id": "PRRT_kwDOEL39TM4w7XDQ",
-    "comments": [
-      {
-        "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280",
-        "pull_request_review_id": 901921390,
-        "id": 820867280,
-        "node_id": "PRRC_kwDOEL39TM4w7XDQ",
-        "diff_hunk": "@@ -0,0 +1 @@\n+issue comment",
-        "path": "issue-comment",
-        "position": 1,
-        "original_position": 1,
-        "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "user": {
-          "login": "jide2020",
-          "id": 64502150,
-          "node_id": "MDQ6VXNlcjY0NTAyMTUw",
-          "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/jide2020",
-          "html_url": "https://github.com/jide2020",
-          "followers_url": "https://api.github.com/users/jide2020/followers",
-          "following_url": "https://api.github.com/users/jide2020/following{/other_user}",
-          "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions",
-          "organizations_url": "https://api.github.com/users/jide2020/orgs",
-          "repos_url": "https://api.github.com/users/jide2020/repos",
-          "events_url": "https://api.github.com/users/jide2020/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/jide2020/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "body": "sup",
-        "created_at": "2022-03-07T16:16:48Z",
-        "updated_at": "2022-03-07T16:16:58Z",
-        "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280",
-        "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-        "author_association": "COLLABORATOR",
-        "_links": {
-          "self": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280"
-          },
-          "html": {
-            "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280"
-          },
-          "pull_request": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-          }
-        },
-        "reactions": {
-          "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions",
-          "total_count": 0,
-          "+1": 0,
-          "-1": 0,
-          "laugh": 0,
-          "hooray": 0,
-          "confused": 0,
-          "heart": 0,
-          "rocket": 0,
-          "eyes": 0
-        },
-        "start_line": null,
-        "original_start_line": null,
-        "start_side": null,
-        "line": 1,
-        "original_line": 1,
-        "side": "RIGHT"
-      }
-    ]
-  },
-  "repository": {
-    "id": 280886604,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 67584941,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-      "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "Change description",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2020-07-19T14:48:35Z",
-    "updated_at": "2022-03-11T11:56:22Z",
-    "pushed_at": "2022-04-01T09:37:36Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 646,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 60,
-    "license": null,
-    "allow_forking": false,
-    "is_template": false,
-    "topics": [
-      "hey",
-      "topic"
-    ],
-    "visibility": "private",
-    "forks": 0,
-    "open_issues": 60,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 67584941,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - push -

    -

    One or more commits are pushed to a repository branch or tag.

    -
    -

    - Note: You will not receive a webhook for this event - when you push more than three tags at once. -

    -
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The full - git ref - that was pushed. Example: refs/heads/main or - refs/tags/v3.14.1. -
    beforestring - The SHA of the most recent commit on ref before the - push. -
    afterstring - The SHA of the most recent commit on ref after the - push. -
    createdbooleanWhether this push created the ref.
    deletedbooleanWhether this push deleted the ref.
    forcedbooleanWhether this push was a force push of the ref.
    head_commitobject - For pushes where after is or points to a commit - object, an expanded representation of that commit. For pushes - where after refers to an annotated tag object, an - expanded representation of the commit pointed to by the annotated - tag. -
    comparestring - 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. -
    commitsarray - 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.) -
    commits[][id]stringThe SHA of the commit.
    commits[][timestamp]stringThe ISO 8601 timestamp of the commit.
    commits[][message]stringThe commit message.
    commits[][author]objectThe git author of the commit.
    commits[][author][name]stringThe git author's name.
    commits[][author][email]stringThe git author's email address.
    commits[][url]urlURL that points to the commit API resource.
    commits[][distinct]boolean - Whether this commit is distinct from any that have been pushed - before. -
    commits[][added]array - An array of files added in the commit. For extremely large commits - where GitHub Enterprise Server is unable to calculate this list in - a timely manner, this may be empty even if files were added. -
    commits[][modified]array - An array of files modified by the commit. For extremely large - commits where GitHub Enterprise Server is unable to calculate this - list in a timely manner, this may be empty even if files were - modified. -
    commits[][removed]array - An array of files removed in the commit. For extremely large - commits where GitHub Enterprise Server is unable to calculate this - list in a timely manner, this may be empty even if files were - removed. -
    pusherobjectThe user who pushed the commits.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "refs/tags/simple-tag",
-  "before": "0000000000000000000000000000000000000000",
-  "after": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-  "created": true,
-  "deleted": false,
-  "forced": false,
-  "base_ref": null,
-  "compare": "https://octocoders.github.io/Codertocat/Hello-World/compare/simple-tag",
-  "commits": [],
-  "head_commit": {
-    "id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "tree_id": "4b825dc642cb6eb9a060e54bf8d69288fbee4904",
-    "distinct": true,
-    "message": "Adding a .gitignore file",
-    "timestamp": "2019-05-15T15:20:41Z",
-    "url": "https://octocoders.github.io/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "author": {
-      "name": "Codertocat",
-      "email": "Codertocat@Octocoders.io",
-      "username": "Codertocat"
-    },
-    "committer": {
-      "name": "Codertocat",
-      "email": "Codertocat@Octocoders.io",
-      "username": "Codertocat"
-    },
-    "added": [
-      ".gitignore"
-    ],
-    "removed": [],
-    "modified": []
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "name": "Codertocat",
-      "email": "Codertocat@Octocoders.io",
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": 1557949027,
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": 1557949103,
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master",
-    "stargazers": 0,
-    "master_branch": "master"
-  },
-  "pusher": {
-    "name": "Codertocat",
-    "email": "Codertocat@Octocoders.io"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - release -

    -

    - Activity related to a release. The type of activity is specified in the - action property of the payload object. For more - information, see the "releases" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - published: a release, pre-release, or draft of a - release is published -
      • -
    • - unpublished: a release or pre-release is deleted -
      • -
    • - created: a draft is saved, or a release or - pre-release is published without previously being saved as a - draft -
      • -
    • - edited: a release, pre-release, or draft release - is edited -
      • -
    • - deleted: a release, pre-release, or draft release - is deleted -
      • -
    • prereleased: a pre-release is created
      • -
    • - released: a release is published, or a - pre-release is changed to a release -
      • -
    -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    releaseobject - The - release - object. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "release": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2",
-    "assets_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets",
-    "upload_url": "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1",
-    "id": 2,
-    "node_id": "MDc6UmVsZWFzZTI=",
-    "tag_name": "0.0.1",
-    "target_commitish": "master",
-    "name": null,
-    "draft": false,
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "prerelease": false,
-    "created_at": "2019-05-15T19:37:08Z",
-    "published_at": "2019-05-15T19:38:20Z",
-    "assets": [],
-    "tarball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1",
-    "zipball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1",
-    "body": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - repository_dispatch -

    -

    - This event occurs when a GitHub App sends a POST request to - the "Create a repository dispatch event" endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "on-demand-test",
-  "branch": "master",
-  "client_payload": {
-    "unit": false,
-    "integration": true
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2018-10-10T15:58:51Z",
-    "pushed_at": "2018-10-10T15:58:47Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 59,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 23,
-    "license": null,
-    "forks": 1,
-    "open_issues": 23,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 375706,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2"
-  }
-}
-
    -
    -

    - - repository -

    -

    - Activity related to a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "repositories" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of: -
      -
    • created - A repository is created.
      • -
    • deleted - A repository is deleted.
      • -
    • archived - A repository is archived.
      • -
    • unarchived - A repository is unarchived.
      • -
    • - anonymous_access_enabled - A repository is - enabled for anonymous Git access, anonymous_access_disabled - A repository is - disabled for anonymous Git access -
      • -
    • - edited - A repository's information is edited. -
      • -
    • renamed - A repository is renamed.
      • -
    • transferred - A repository is transferred.
      • -
    • publicized - A repository is made public.
      • -
    • privatized - A repository is made private.
      • -
    -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "publicized",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - secret_scanning_alert -

    -

    - Activity related to secret scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see the "secret scanning API." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be either - created, resolved, or - reopened. -
    alertobjectThe secret scanning alert involved in the event.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is resolved or - reopened, the sender object will be the - user that triggered the event. The sender object is - empty for all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 191,
-    "secret_type": "adafruit_io_key",
-    "resolution": null,
-    "resolved_by": null,
-    "resolved_at": null
-  },
-  "repository": {
-    "id": 257423561,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 30846345,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2020-04-20T22:59:11Z",
-    "updated_at": "2020-11-24T01:37:33Z",
-    "pushed_at": "2020-11-24T01:37:31Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 1156,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": false,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 3,
-    "license": null,
-    "forks": 0,
-    "open_issues": 3,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Codertocat",
-    "id": 30846345,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-    "url": "https://api.github.com/orgs/Codertocat",
-    "repos_url": "https://api.github.com/orgs/Codertocat/repos",
-    "events_url": "https://api.github.com/orgs/Codertocat/events",
-    "hooks_url": "https://api.github.com/orgs/Codertocat/hooks",
-    "issues_url": "https://api.github.com/orgs/Codertocat/issues",
-    "members_url": "https://api.github.com/orgs/Codertocat/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Codertocat/public_members{/member}",
-    "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-    "description": "Demos and testing of GitHub security products"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 10136561,
-    "node_id": "MDQ6VXNlcjEwMTM2NTYx",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/10136561?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - security_advisory -

    -

    - Activity related to a security advisory that has been reviewed by - GitHub. A GitHub-reviewed security advisory provides information about - security-related vulnerabilities in software on GitHub. -

    -

    - The security advisory dataset also powers the GitHub Dependabot alerts. - For more information, see "About Dependabot alerts." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. The action can be one of - published, updated, - performed, or withdrawn for all new - events. -
    security_advisoryobject - The details of the security advisory, including summary, - description, and severity. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "security_advisory": {
-    "ghsa_id": "GHSA-rf4j-j272-fj86",
-    "summary": "Moderate severity vulnerability that affects django",
-    "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
-    "severity": "moderate",
-    "identifiers": [
-      {
-        "value": "GHSA-rf4j-j272-fj86",
-        "type": "GHSA"
-      },
-      {
-        "value": "CVE-2018-6188",
-        "type": "CVE"
-      }
-    ],
-    "references": [
-      {
-        "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
-      }
-    ],
-    "published_at": "2018-10-03T21:13:54Z",
-    "updated_at": "2018-10-03T21:13:54Z",
-    "withdrawn_at": null,
-    "vulnerabilities": [
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
-        "first_patched_version": {
-          "identifier": "2.0.2"
-        }
-      },
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
-        "first_patched_version": {
-          "identifier": "1.11.10"
-        }
-      }
-    ]
-  }
-}
-
    -
    -

    - - star -

    -

    - Activity related to a repository being starred. The type of activity is - specified in the action property of the payload object. For - more information, see the "starring" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created or - deleted. -
    starred_atstring - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "starred_at": "2019-05-15T15:20:40Z",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:40Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - status -

    -

    - When the status of a Git commit changes. For more information, see the - "statuses" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    idintegerThe unique identifier of the status.
    shastringThe Commit SHA.
    statestring - The new state. Can be pending, success, - failure, or error. -
    descriptionstring - The optional human-readable description added to the status. -
    target_urlstringThe optional link added to the status.
    branchesarray - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + repository +

    +
    +
    + Activity related to a repository. The type of activity is + specified in the action property of the payload + object. For more information, see the "repositories" REST API. +
    +

    Availability for repository

    +
      +
    • + Repository webhooks receive all event types except + deleted +
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Metadata permission receive + all event types except deleted +
      • +
    +

    Webhook payload object for repository

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 2,
-  "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-  "name": "Codertocat/Hello-World",
-  "target_url": null,
-  "context": "default",
-  "description": null,
-  "state": "success",
-  "commit": {
-    "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "node_id": "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=",
-    "commit": {
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@Octocoders.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "committer": {
-        "name": "GitHub Enterprise",
-        "email": "noreply@octocoders.github.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "message": "Initial commit",
-      "tree": {
-        "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4"
-      },
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-      "comment_count": 1,
-      "verification": {
-        "verified": false,
-        "reason": "unsigned",
-        "signature": null,
-        "payload": null
-      }
-    },
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments",
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "committer": null,
-    "parents": []
-  },
-  "branches": [
-    {
-      "name": "master",
-      "commit": {
-        "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a"
-      },
-      "protected": false
-    },
-    {
-      "name": "changes",
-      "commit": {
-        "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1"
-      },
-      "protected": false
-    },
-    {
-      "name": "gh-pages",
-      "commit": {
-        "sha": "3648135c2986115284ae152d90459473b15fd19c",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c"
-      },
-      "protected": false
-    }
-  ],
-  "created_at": "2019-05-15T19:38:21+00:00",
-  "updated_at": "2019-05-15T19:38:21+00:00",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. This can be one of: +
      +
    • + created - A repository is created. +
      • +
    • + deleted - A repository is deleted. +
      • +
    • + archived - A repository is + archived. +
      • +
    • + unarchived - A repository is + unarchived. +
      • +
    • + anonymous_access_enabled - A + repository is + enabled for anonymous Git access, anonymous_access_disabled - A + repository is + disabled for anonymous Git access +
      • +
    • + edited - A repository's information + is edited. +
      • +
    • + renamed - A repository is renamed. +
      • +
    • + transferred - A repository is + transferred. +
      • +
    • + publicized - A repository is made + public. +
      • +
    • + privatized - A repository is made + private. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "action": "publicized", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - team -

    -

    - Activity related to an organization's team. The type of activity is - specified in the action property of the payload object. For - more information, see the "teams" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - deleted, edited, - added_to_repository, or - removed_from_repository. -
    teamobjectThe team itself.
    changesobject - The changes to the team if the action was edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[privacy][from]string - The previous version of the team's privacy if the action was - edited. -
    changes[repository][permissions][from][admin]boolean - The previous version of the team member's - admin permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][pull]boolean - The previous version of the team member's - pull permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][push]boolean - The previous version of the team member's - push permission on a repository, if the action was - edited. -
    repositoryobject - The repository that was added or removed from to the team's - purview if the action was added_to_repository, - removed_from_repository, or edited. For - edited actions, repository also contains - the team's new permission levels for the repository. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + repository_vulnerability_alert +

    +
    +
    +

    + This event occurs when there is activity relating to a security + vulnerability alert in a repository. +

    +

    + Note: This event is deprecated. Use the + dependabot_alert event instead. +

    +
    +

    + Availability for repository_vulnerability_alert +

    +
      +
    • repository
      • +
    • organization
      • +
    +

    + Webhook payload object for + repository_vulnerability_alert +

    +
    +
    + +
    +
    +

    A repository vulnerability alert was created.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added_to_repository",
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "permissions": {
-      "pull": true,
-      "push": false,
-      "admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: create +

    +
    +
    +
    +
    +
    +
    + alert Required +
    +
    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +

    An enterprise on GitHub.

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. This property is + included when the event is configured for and sent + to a GitHub App. +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +

    A GitHub organization.

    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +

    A repository on GitHub.

    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +

    A GitHub user.

    +
    +
    +
    +
    + + + -

    - - team_add -

    -

    - When a - repository is added to a team. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    teamobject - The - team - that was modified. Note: Older events may not - include this in the payload. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + secret_scanning_alert +

    +
    +
    + Activity related to secret scanning alerts in a repository. The + type of activity is specified in the action property of the + payload object. For more information, see the "secret scanning API." +
    +

    Availability for secret_scanning_alert

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Secret scanning alerts permission +
      • +
    +

    + Webhook payload object for secret_scanning_alert +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. This can be either + created, resolved, or + reopened. +
    +
    +
    +
    +
    +
    +
    alert object
    +
    +
    + The secret scanning alert involved in the event. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    + If the action is + resolved or reopened, the + sender object will be the user that + triggered the event. The sender object + is empty for all other actions. +
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "reopened", "alert": { "number": 191, "secret_type": + "adafruit_io_key", "resolution": null, "resolved_by": null, + "resolved_at": null }, "repository": { "id": 257423561, "node_id": + "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": true, "owner": { + "login": "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2020-04-20T22:59:11Z", "updated_at": + "2020-11-24T01:37:33Z", "pushed_at": "2020-11-24T01:37:31Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 1156, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": + false, "has_projects": false, "has_downloads": true, "has_wiki": + false, "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 3, + "license": null, "forks": 0, "open_issues": 3, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "url": + "https://api.github.com/orgs/Codertocat", "repos_url": + "https://api.github.com/orgs/Codertocat/repos", "events_url": + "https://api.github.com/orgs/Codertocat/events", "hooks_url": + "https://api.github.com/orgs/Codertocat/hooks", "issues_url": + "https://api.github.com/orgs/Codertocat/issues", "members_url": + "https://api.github.com/orgs/Codertocat/members{/member}", + "public_members_url": + "https://api.github.com/orgs/Codertocat/public_members{/member}", + "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "description": "Demos and testing of GitHub security products" }, + "sender": { "login": "Codertocat", "id": 10136561, "node_id": + "MDQ6VXNlcjEwMTM2NTYx", "avatar_url": + "https://avatars1.githubusercontent.com/u/10136561?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": true } } +
    + -

    - - user -

    -

    When a user is created or deleted.

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "user": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "action": "created",
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + security_advisory +

    +
    +
    + Activity related to a security advisory that has been reviewed by + GitHub. A GitHub-reviewed security advisory provides information + about security-related vulnerabilities in software on GitHub.The + security advisory dataset also powers the GitHub Dependabot + alerts. For more information, see "About Dependabot alerts." +
    +

    Availability for security_advisory

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for security_advisory

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. The action can be one + of published, updated, + performed, or + withdrawn for all new events. +
    +
    +
    +
    +
    +
    +
    + security_advisory object +
    +
    +
    + The details of the security advisory, including + summary, description, and severity. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "security_advisory": { "ghsa_id": + "GHSA-rf4j-j272-fj86", "summary": "Moderate severity vulnerability + that affects django", "description": + "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before + 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain + potentially sensitive information by leveraging data exposure from + the confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive.", "severity": "moderate", + "identifiers": [ { "value": "GHSA-rf4j-j272-fj86", "type": "GHSA" + }, { "value": "CVE-2018-6188", "type": "CVE" } ], "references": [ + { "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" } ], + "published_at": "2018-10-03T21:13:54Z", "updated_at": + "2018-10-03T21:13:54Z", "withdrawn_at": null, "vulnerabilities": [ + { "package": { "ecosystem": "pip", "name": "django" }, "severity": + "moderate", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { "identifier": "2.0.2" } }, { "package": + { "ecosystem": "pip", "name": "django" }, "severity": "moderate", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { "identifier": "1.11.10" } } ] } } +
    +
    -

    - - watch -

    -

    - When someone stars a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "starring" REST API. -

    -

    - The event’s actor is the - user who - starred a repository, and the event’s repository is the - repository - that was starred. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - started. -
    repositoryobject - The - repository +
    +

    + star +

    +
    +
    + Activity related to a repository being starred. The type of + activity is specified in the action property of the + payload object. For more information, see the "starring" REST API. +
    +

    Availability for star

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for star

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created or + deleted. +
    +
    +
    +
    +
    +
    +
    starred_at string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "starred_at": "2019-05-15T15:20:40Z", + "repository": { "id": 186853002, "node_id": + "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", "updated_at": + "2019-05-15T15:20:40Z", "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 1, + "watchers_count": 1, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 1, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    + +
    +
    +

    + status +

    +
    +
    + When the status of a Git commit changes. For more information, see + the "statuses" REST API. +
    +

    Availability for status

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Commit statuses permission +
      • +
    +

    Webhook payload object for status

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "started",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    id integer
    +
    +
    The unique identifier of the status.
    +
    +
    +
    +
    +
    +
    sha string
    +
    +
    The Commit SHA.
    +
    +
    +
    +
    +
    +
    state string
    +
    +
    + The new state. Can be pending, + success, failure, or + error. +
    +
    +
    +
    +
    +
    +
    description string
    +
    +
    + The optional human-readable description added to the + status. +
    +
    +
    +
    +
    +
    +
    target_url string
    +
    +
    The optional link added to the status.
    +
    +
    +
    +
    +
    +
    branches array
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "id": 2, "sha": "4544205a385319fd846d5df4ed2e3b8173529d78", + "name": "Codertocat/Hello-World", "target_url": null, "context": + "default", "description": null, "state": "success", "commit": { + "sha": "4544205a385319fd846d5df4ed2e3b8173529d78", "node_id": + "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=", + "commit": { "author": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "date": "2019-05-15T19:37:08Z" }, + "committer": { "name": "GitHub Enterprise", "email": + "noreply@octocoders.github.io", "date": "2019-05-15T19:37:08Z" }, + "message": "Initial commit", "tree": { "sha": + "1b13fc88733f95cc8cb16170f6990ef30d78acf4", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4" + }, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78", + "comment_count": 1, "verification": { "verified": false, "reason": + "unsigned", "signature": null, "payload": null } }, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments", + "author": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "committer": null, + "parents": [] }, "branches": [ { "name": "master", "commit": { + "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a" + }, "protected": false }, { "name": "changes", "commit": { "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1" + }, "protected": false }, { "name": "gh-pages", "commit": { "sha": + "3648135c2986115284ae152d90459473b15fd19c", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c" + }, "protected": false } ], "created_at": + "2019-05-15T19:38:21+00:00", "updated_at": + "2019-05-15T19:38:21+00:00", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - workflow_dispatch -

    -

    - This event occurs when someone triggers a workflow run on GitHub or - sends a POST request to the "Create a workflow dispatch event" endpoint. For more information, see "Events that trigger workflows." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    inputsobject - Inputs to the workflow. Each key represents the name of the input - while its value represents the value of that input. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + team +

    +
    +
    + Activity related to an organization's team. The type of activity + is specified in the action property of the payload + object. For more information, see the "teams" REST API. +
    +

    Availability for team

    +
      +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for team

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    refstringThe branch or tag from which the workflow was run.
    repositoryobject - The +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + created, deleted, + edited, + added_to_repository, or + removed_from_repository. +
    +
    +
    +
    +
    +
    +
    team object
    +
    +
    The team itself.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the team if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[description][from] + string +
    +
    +
    + The previous version of the description if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[privacy][from] + string +
    +
    +
    + The previous version of the team's privacy if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][admin] + boolean +
    +
    +
    + The previous version of the team member's + admin permission on a repository, if + the action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][pull] + boolean +
    +
    +
    + The previous version of the team member's + pull permission on a repository, if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][push] + boolean +
    +
    +
    + The previous version of the team member's + push permission on a repository, if the + action was edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The repository that was added or removed from to the + team's purview if the action was + added_to_repository, + removed_from_repository, or + edited. For + edited actions, + repository also contains the team's new + permission levels for the repository. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added_to_repository", "team": { "name": "github", + "id": 3, "node_id": "MDQ6VGVhbTM=", "slug": "github", + "description": "Open-source team", "privacy": "secret", "url": + "https://octocoders.github.io/api/v3/teams/3", "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master", "permissions": { "pull": true, "push": + false, "admin": false } }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    + +
    +
    +

    + team_add +

    +
    +
    + When a repositoryrepository is added to a team. +
    +

    Availability for team_add

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for team_add

    +
    +
    + - where the event occurred. - - - - - - - - - - - - - -
    senderobjectThe user that triggered the event.
    workflowstring - Relative path to the workflow file which contains the workflow. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "inputs": {
-    "name": "Mona the Octocat"
-  },
-  "organization": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": null,
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "id": 79927191,
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "login": "octo-org",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "url": "https://api.github.com/orgs/octo-org"
-  },
-  "ref": "refs/heads/main",
-  "repository": {
-    "allow_forking": true,
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "created_at": "2021-08-16T21:34:28Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "fork": false,
-    "forks": 1,
-    "forks_count": 1,
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "full_name": "octo-org/octo-repo",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "id": 6811672,
-    "is_template": false,
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "mirror_url": null,
-    "name": "octo-repo",
-    "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "open_issues": 97,
-    "open_issues_count": 97,
-    "owner": {
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/octo-org",
-      "id": 79927191,
-      "login": "octo-org",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/octo-org"
-    },
-    "private": false,
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "pushed_at": "2022-01-07T21:57:21Z",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "size": 144,
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "topics": [],
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "updated_at": "2022-01-07T21:57:24Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "visibility": "public",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/25328854?v=4",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/octocat",
-    "id": 25328754,
-    "login": "octocat",
-    "node_id": "MDQ6VXNlcjI1MzI4ODU0",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/octocat"
-  },
-  "workflow": ".github/workflows/hello-world-workflow.yml"
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    team object
    +
    +
    + The + team + that was modified. Note: Older + events may not include this in the payload. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "team": { "name": "github", "id": 3, "node_id": "MDQ6VGVhbTM=", + "slug": "github", "description": "Open-source team", "privacy": + "secret", "url": "https://octocoders.github.io/api/v3/teams/3", + "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false } } +
    + -

    - - workflow_job -

    -

    - A GitHub Actions workflow job has been queued, is in progress, or has - been completed on a repository. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • queued - A new job was created.
      • -
    • - in_progress - The job has started processing on - the runner. -
      • -
    • - completed - The status of the job is - completed. -
      • -
    -
    workflow_jobobject - The workflow job. Many workflow_job keys, such as - head_sha, conclusion, and - started_at are the same as those in a - check_run object. -
    workflow_job[status]string - The current status of the job. Can be queued, - in_progress, or completed. -
    workflow_job[labels]array - Custom labels for the job. Specified by the - "runs-on" attribute +
    +

    + user +

    +
    +
    + When a user is created or deleted. +
    +

    Availability for user

    +
      +
    • + GitHub Enterprise webhooks. For more information, "Global webhooks." +
      • +
    +

    Webhook payload object for user

    +
    +
    + - in the workflow YAML. - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
    workflow_job[runner_id]integer - The ID of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_name]string - The name of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_id]integer - The ID of the runner group that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_name]string - The name of the runner group that is running this job. This will - be null as long as - workflow_job[status] is queued. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    +
    +
    +

    Webhook payload example

    +
    + { "user": { "login": "Snowtocat", "id": 16, "node_id": + "MDQ6VXNlcjE2", "avatar_url": + "https://octocoders.github.io/avatars/u/16?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Snowtocat", + "html_url": "https://octocoders.github.io/Snowtocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/received_events", + "type": "User", "site_admin": false }, "action": "created", + "enterprise": { "id": 1, "slug": "github", "name": "GitHub", + "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Snowtocat", "id": 16, "node_id": + "MDQ6VXNlcjE2", "avatar_url": + "https://octocoders.github.io/avatars/u/16?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Snowtocat", + "html_url": "https://octocoders.github.io/Snowtocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/received_events", + "type": "User", "site_admin": false } } +
    +
    + +
    +
    +

    + watch +

    +
    +
    + When someone stars a repository. The type of activity is specified + in the action property of the payload object. For + more information, see the "starring" REST API.The event’s actor is the + user + who starred a repository, and the event’s repository is the + repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization +

    Availability for watch

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object for watch

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "in_progress",
-  "workflow_job": {
-    "id": 2832853555,
-    "run_id": 940463255,
-    "run_url": "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255",
-    "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55",
-    "head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055",
-    "url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555",
-    "html_url": "https://github.com/octo-org/example-workflow/runs/2832853555",
-    "status": "in_progress",
-    "conclusion": null,
-    "started_at": "2021-06-15T19:22:27Z",
-    "completed_at": null,
-    "name": "Test workflow",
-    "steps": [
-      {
-        "name": "Set up job",
-        "status": "in_progress",
-        "conclusion": null,
-        "number": 1,
-        "started_at": "2021-06-15T19:22:27.000Z",
-        "completed_at": null
-      }
-    ],
-    "check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555",
-    "labels": [
-      "gpu",
-      "db-app",
-      "dc-03"
-    ],
-    "runner_id": 1,
-    "runner_name": "my runner",
-    "runner_group_id": 2,
-    "runner_group_name": "my runner group"
-  },
-  "repository": {
-    "id": 376034443,
-    "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55",
-    "name": "example-workflow",
-    "full_name": "octo-org/example-workflow",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 33435655,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-      "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/example-workflow",
-    "description": "Test workflow",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/example-workflow",
-    "forks_url": "https://api.github.com/repos/octo-org/example-workflow/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/example-workflow/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/example-workflow/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/example-workflow/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/example-workflow/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/example-workflow/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/example-workflow/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/example-workflow/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/example-workflow/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/example-workflow/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/example-workflow/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/example-workflow/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/example-workflow/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/example-workflow/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/example-workflow/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/example-workflow/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/example-workflow/deployments",
-    "created_at": "2021-06-11T13:29:13Z",
-    "updated_at": "2021-06-11T13:33:01Z",
-    "pushed_at": "2021-06-11T13:32:58Z",
-    "git_url": "git://github.com/octo-org/example-workflow.git",
-    "ssh_url": "git@github.com:octo-org/example-workflow.git",
-    "clone_url": "https://github.com/octo-org/example-workflow.git",
-    "svn_url": "https://github.com/octo-org/example-workflow",
-    "homepage": null,
-    "size": 1,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 33435655,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "description": "octo-org"
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 319655,
-    "node_id": "MDQ6VXNlcjMxOTY1NQ55",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Currently, can only + be started. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "started", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:09Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 1, + "watchers_count": 1, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 1, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - workflow_run -

    -

    - When a GitHub Actions workflow run is requested or completed. For more - information, see "Events that trigger workflows." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of - requested or completed. -
    workflow_runobject - The workflow run. Includes information such as - artifacts_url, check_suite_id, - conclusion, head_branch, and - head_sha. -
    workflowobjectThe workflow that generated the workflow run.
    organizationobject - Webhook payloads contain the - organization +
    +

    + workflow_dispatch +

    +
    +
    + This event occurs when someone triggers a workflow run on GitHub + or sends a POST request to the "Create a workflow dispatch event" endpoint. For more information, see "Events that trigger workflows." +
    +

    Availability for workflow_dispatch

    +
      +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for workflow_dispatch

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    inputs object
    +
    +
    + Inputs to the workflow. Each key represents the name + of the input while its value represents the value of + that input. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    ref string
    +
    +
    + The branch or tag from which the workflow was run. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    workflow string
    +
    +
    + Relative path to the workflow file which contains + the workflow. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "inputs": { "name": "Mona the Octocat" }, "organization": { + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "description": null, "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "id": 79927191, + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "login": "octo-org", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "repos_url": "https://api.github.com/orgs/octo-org/repos", "url": + "https://api.github.com/orgs/octo-org" }, "ref": + "refs/heads/main", "repository": { "allow_forking": true, + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "archived": false, "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "created_at": "2021-08-16T21:34:28Z", "default_branch": "main", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "disabled": false, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks": 1, "forks_count": 1, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_url": "git://github.com/octo-org/octo-repo.git", + "has_downloads": true, "has_issues": true, "has_pages": false, + "has_projects": true, "has_wiki": true, "homepage": null, + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 6811672, "is_template": false, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "language": null, "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "license": null, "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "mirror_url": null, "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "open_issues": 97, "open_issues_count": 97, "owner": { + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": false, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "pushed_at": "2022-01-07T21:57:21Z", "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "size": 144, "ssh_url": "git@github.com:octo-org/octo-repo.git", + "stargazers_count": 0, "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "svn_url": "https://github.com/octo-org/octo-repo", "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", "topics": + [], "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "updated_at": "2022-01-07T21:57:24Z", "url": + "https://api.github.com/repos/octo-org/octo-repo", "visibility": + "public", "watchers": 0, "watchers_count": 0 }, "sender": { + "avatar_url": + "https://avatars.githubusercontent.com/u/25328854?v=4", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octocat", "id": + 25328754, "login": "octocat", "node_id": "MDQ6VXNlcjI1MzI4ODU0", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": + "https://api.github.com/users/octocat/received_events", + "repos_url": "https://api.github.com/users/octocat/repos", + "site_admin": true, "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", "type": + "User", "url": "https://api.github.com/users/octocat" }, + "workflow": ".github/workflows/hello-world-workflow.yml" } +
    +
    + +
    +
    +

    + workflow_job +

    +
    +
    + A GitHub Actions workflow job has been queued, is in progress, or + has been completed on a repository. The type of activity is + specified in the action property of the payload + object. +
    +

    Availability for workflow_job

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • Enterprise webhooks
      • +
    +

    Webhook payload object for workflow_job

    +
    +
    + - where the event occurred. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "organization": {
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "description": "",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "id": 33435682,
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "login": "Codertocat",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "url": "https://api.github.com/orgs/Codertocat"
-  },
-  "repository": {
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "created_at": "2020-07-29T09:57:16Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "fork": false,
-    "forks": 0,
-    "forks_count": 0,
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "full_name": "Codertocat/Hello-World",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "id": 283462325,
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "mirror_url": null,
-    "name": "Hello-World",
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "open_issues": 0,
-    "open_issues_count": 0,
-    "owner": {
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/Codertocat",
-      "id": 33435682,
-      "login": "Codertocat",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/Codertocat"
-    },
-    "private": true,
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "pushed_at": "2020-07-29T10:06:16Z",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "size": 0,
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "updated_at": "2020-07-29T10:06:18Z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars3.githubusercontent.com/u/54248166?v=4",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/Codertocat",
-    "id": 54248166,
-    "login": "Codertocat",
-    "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/Codertocat"
-  },
-  "workflow": {
-    "badge_url": "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg",
-    "created_at": "2021-12-15T20:11:38.000Z",
-    "html_url": "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml",
-    "id": 16340987,
-    "name": "Manually triggered workflow",
-    "node_id": "W_kwDOF6lyTM4A-Vf7",
-    "path": ".github/workflows/syntax.yml",
-    "state": "active",
-    "updated_at": "2021-12-16T18:40:41.000Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  },
-  "workflow_run": {
-    "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts",
-    "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel",
-    "check_suite_id": 4683454167,
-    "check_suite_node_id": "CS_kwDOF6lyTM8AAAABFyfW1w",
-    "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167",
-    "conclusion": null,
-    "created_at": "2021-12-16T19:37:22Z",
-    "event": "workflow_dispatch",
-    "head_branch": "main",
-    "head_commit": {
-      "author": {
-        "email": "octocat@github.com",
-        "name": "Mona Lisa"
-      },
-      "committer": {
-        "email": "noreply@github.com",
-        "name": "GitHub"
-      },
-      "id": "5779607b49aab1200488439f02372c57b4f75444",
-      "message": "Update milestone-created.yml",
-      "timestamp": "2021-12-16T19:37:14Z",
-      "tree_id": "8181cee091cf9627ac07c3cc4b94c015a1d56706"
-    },
-    "head_repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "head_sha": "5779607b49aab1200488439f02372c57b4f75444",
-    "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1589141559",
-    "id": 1589141559,
-    "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs",
-    "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs",
-    "name": "Manually triggered workflow",
-    "node_id": "WFR_kwLOF6lyTM5euGA3",
-    "previous_attempt_url": null,
-    "pull_requests": [],
-    "repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun",
-    "run_attempt": 1,
-    "run_number": 36,
-    "run_started_at": "2021-12-16T19:37:22Z",
-    "status": "queued",
-    "updated_at": "2021-12-16T19:37:22Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559",
-    "workflow_id": 16340987,
-    "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be one of: +
      +
    • + queued - A new job was created. +
      • +
    • + in_progress - The job has started + processing on the runner. +
      • +
    • + completed - The + status of the job is + completed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    workflow_job object
    +
    +
    + The workflow job. Many + workflow_job keys, such as + head_sha, conclusion, and + started_at are the same as those in a + check_run + object. +
    +
    +
    +
    +
    +
    +
    + workflow_job[status] string +
    +
    +
    + The current status of the job. Can be + queued, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + workflow_job[labels] array +
    +
    +
    + Custom labels for the job. Specified by the + "runs-on" attribute + in the workflow YAML. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_id] + integer +
    +
    +
    + The ID of the runner that is running this job. This + will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_name] + string +
    +
    +
    + The name of the runner that is running this job. + This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_group_id] + integer +
    +
    +
    + The ID of the runner group that is running this job. + This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_group_name] + string +
    +
    +
    + The name of the runner group that is running this + job. This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "in_progress", "workflow_job": { "id": 2832853555, + "run_id": 940463255, "run_url": + "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255", + "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55", "head_sha": + "e3103f8eb03e1ad7f2331c5446b23c070fc54055", "url": + "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555", + "html_url": + "https://github.com/octo-org/example-workflow/runs/2832853555", + "status": "in_progress", "conclusion": null, "started_at": + "2021-06-15T19:22:27Z", "completed_at": null, "name": "Test + workflow", "steps": [ { "name": "Set up job", "status": + "in_progress", "conclusion": null, "number": 1, "started_at": + "2021-06-15T19:22:27.000Z", "completed_at": null } ], + "check_run_url": + "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555", + "labels": [ "gpu", "db-app", "dc-03" ], "runner_id": 1, + "runner_name": "my runner", "runner_group_id": 2, + "runner_group_name": "my runner group" }, "repository": { "id": + 376034443, "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55", "name": + "example-workflow", "full_name": "octo-org/example-workflow", + "private": true, "owner": { "login": "octo-org", "id": 33435655, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/example-workflow", "description": + "Test workflow", "fork": false, "url": + "https://api.github.com/repos/octo-org/example-workflow", + "forks_url": + "https://api.github.com/repos/octo-org/example-workflow/forks", + "keys_url": + "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/example-workflow/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/example-workflow/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/example-workflow/events", + "assignees_url": + "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/example-workflow/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/example-workflow/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/example-workflow/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/example-workflow/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/example-workflow/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/example-workflow/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/example-workflow/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/example-workflow/merges", + "archive_url": + "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/example-workflow/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/example-workflow/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/example-workflow/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/example-workflow/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/example-workflow/deployments", + "created_at": "2021-06-11T13:29:13Z", "updated_at": + "2021-06-11T13:33:01Z", "pushed_at": "2021-06-11T13:32:58Z", + "git_url": "git://github.com/octo-org/example-workflow.git", + "ssh_url": "git@github.com:octo-org/example-workflow.git", + "clone_url": "https://github.com/octo-org/example-workflow.git", + "svn_url": "https://github.com/octo-org/example-workflow", + "homepage": null, "size": 1, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "main" }, "organization": { "login": "octo-org", + "id": 33435655, "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", + "url": "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "description": "octo-org" }, "sender": { "login": "octocat", "id": + 319655, "node_id": "MDQ6VXNlcjMxOTY1NQ55", "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true } } +
    + + +
    +
    +

    + workflow_run +

    +
    +
    + When a GitHub Actions workflow run is requested or completed. For + more information, see "Events that trigger workflows." +
    +

    Availability for workflow_run

    +
      +
    • + GitHub Apps with Actions or + Contents permissions +
      • +
    +

    Webhook payload object for workflow_run

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + requested or completed. +
    +
    +
    +
    +
    +
    +
    workflow_run object
    +
    +
    + The workflow run. Includes information such as + artifacts_url, + check_suite_id, + conclusion, head_branch, + and head_sha. +
    +
    +
    +
    +
    +
    +
    workflow object
    +
    +
    + The workflow that generated the workflow run. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "completed", "organization": { "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "description": "", "events_url": + "https://api.github.com/orgs/Octocoders/events", "hooks_url": + "https://api.github.com/orgs/Octocoders/hooks", "id": 33435682, + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "login": "Codertocat", "members_url": + "https://api.github.com/orgs/Octocoders/members{/member}", + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "public_members_url": + "https://api.github.com/orgs/Octocoders/public_members{/member}", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "url": "https://api.github.com/orgs/Codertocat" }, "repository": { + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "archived": false, "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "created_at": "2020-07-29T09:57:16Z", "default_branch": "main", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "description": null, "disabled": false, "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "fork": false, "forks": 0, "forks_count": 0, "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "full_name": "Codertocat/Hello-World", "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "has_downloads": true, "has_issues": true, "has_pages": false, + "has_projects": true, "has_wiki": true, "homepage": null, + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "html_url": "https://github.com/Codertocat/Hello-World", "id": + 283462325, "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "language": null, "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "license": null, "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "mirror_url": null, "name": "Hello-World", "node_id": + "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=", "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/Codertocat", + "id": 33435682, "login": "Codertocat", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy", "organizations_url": + "https://api.github.com/users/Codertocat/orgs", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/Codertocat" + }, "private": true, "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "pushed_at": "2020-07-29T10:06:16Z", "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "size": 0, "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "stargazers_count": 0, "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "svn_url": "https://github.com/Codertocat/Hello-World", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "updated_at": "2020-07-29T10:06:18Z", "url": + "https://api.github.com/repos/Codertocat/Hello-World", "watchers": + 0, "watchers_count": 0 }, "sender": { "avatar_url": + "https://avatars3.githubusercontent.com/u/54248166?v=4", + "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/Codertocat", + "id": 54248166, "login": "Codertocat", "node_id": + "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", "organizations_url": + "https://api.github.com/users/Codertocat/orgs", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": true, "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", "type": + "User", "url": "https://api.github.com/users/Codertocat" }, + "workflow": { "badge_url": + "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg", + "created_at": "2021-12-15T20:11:38.000Z", "html_url": + "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml", + "id": 16340987, "name": "Manually triggered workflow", "node_id": + "W_kwDOF6lyTM4A-Vf7", "path": ".github/workflows/syntax.yml", + "state": "active", "updated_at": "2021-12-16T18:40:41.000Z", + "url": + "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" + }, "workflow_run": { "artifacts_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts", + "cancel_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel", + "check_suite_id": 4683454167, "check_suite_node_id": + "CS_kwDOF6lyTM8AAAABFyfW1w", "check_suite_url": + "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167", + "conclusion": null, "created_at": "2021-12-16T19:37:22Z", "event": + "workflow_dispatch", "head_branch": "main", "head_commit": { + "author": { "email": "octocat@github.com", "name": "Mona Lisa" }, + "committer": { "email": "noreply@github.com", "name": "GitHub" }, + "id": "5779607b49aab1200488439f02372c57b4f75444", "message": + "Update milestone-created.yml", "timestamp": + "2021-12-16T19:37:14Z", "tree_id": + "8181cee091cf9627ac07c3cc4b94c015a1d56706" }, "head_repository": { + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 396980812, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "owner": { "avatar_url": + "https://avatars.githubusercontent.com/u/79927191?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": true, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, + "head_sha": "5779607b49aab1200488439f02372c57b4f75444", + "html_url": + "https://github.com/octo-org/octo-repo/actions/runs/1589141559", + "id": 1589141559, "jobs_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs", + "logs_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs", + "name": "Manually triggered workflow", "node_id": + "WFR_kwLOF6lyTM5euGA3", "previous_attempt_url": null, + "pull_requests": [], "repository": { "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 396980812, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "owner": { "avatar_url": + "https://avatars.githubusercontent.com/u/79927191?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": true, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, + "rerun_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun", + "run_attempt": 1, "run_number": 36, "run_started_at": + "2021-12-16T19:37:22Z", "status": "queued", "updated_at": + "2021-12-16T19:37:22Z", "url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559", + "workflow_id": 16340987, "workflow_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" + } } +
    +
    diff --git a/cache/ghes-35/webhook-events-and-payloads.html b/cache/ghes-35/webhook-events-and-payloads.html index dbd19f095..e2c1d1f1f 100644 --- a/cache/ghes-35/webhook-events-and-payloads.html +++ b/cache/ghes-35/webhook-events-and-payloads.html @@ -1,15 +1,19 @@
    -

    Webhook events and payloads

    +

    Webhook events and payloads

    -

    In this article

    -
    -
    +

    - For each webhook event, you can review when the event occurs, an example - payload, and descriptions about the payload object parameters. + Learn about when each webhook event occurs and what the payload contains.

    @@ -499,44 +723,32 @@

    In this article

    - When configuring a webhook, you can use the UI or API to choose which - events will send you payloads. Only subscribing to the specific events - you plan on handling limits the number of HTTP requests to your server. - You can also subscribe to all current and future events. By default, - webhooks are only subscribed to the push event. You can change the list - of subscribed events anytime. + When configuring a webhook, you can choose which events will send you + payloads. To limit the number of HTTP requests to your server, you + should only subscribe to the specific events that you plan on handling. + By default, webhooks installed on + GitHub Enterprise, an [organization][org-hooks], or a [repository][repo-hooks] are only + subscribed to the push event. By default, webhooks on GitHub Apps are + not subscribed to any events. You can change events that a webhook is + subscribed to at any time.

    You can create webhooks that subscribe to the events listed on this page. Each webhook event includes a description of the webhook properties and an example payload. For more information, see "Creating webhooks."

    -

    - - Webhook payload object common properties +

    + Webhook payload object common properties

    Each webhook event payload also contains properties unique to the event. @@ -547,9 +759,9 @@

    - - - + + + @@ -574,8 +786,7 @@

    @@ -614,9 +824,8 @@

    The unique properties for a webhook event are the same properties you'll find in the payload property when using the - Events API. One exception is the push event. The + Events API. + One exception is the push event. The unique properties of the push event webhook payload and the payload property in the Events API differ. The webhook payload contains more detailed information. @@ -630,121 +839,66 @@

    ensure delivery.

    -

    - - Delivery headers +

    + Delivery headers

    HTTP POST payloads that are delivered to your webhook's configured URL - endpoint will contain several special headers: + endpoint will contain several special headers.

    - -
    KeyTypeDescriptionKeyTypeDescription
    object The - repository where the event occurred. Webhook payloads contain the @@ -588,8 +799,7 @@

    		object Webhook payloads contain the - organization object when the webhook is configured for an organization or the @@ -604,8 +814,8 @@

    The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see "Building GitHub AppRegistering a GitHub App."

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HeaderDescription
    X-GitHub-EventName of the event that triggered the delivery.
    X-GitHub-Delivery - A - GUID - to identify the delivery. -
    X-GitHub-Enterprise-Version - The version of the GitHub Enterprise Server instance that sent the - HTTP POST payload. -
    X-GitHub-Enterprise-Host - The hostname of the GitHub Enterprise Server instance that sent - the HTTP POST payload. -
    X-Hub-Signature - This header is sent if the webhook is configured with a - secret. This is the HMAC hex digest of the request body, and is - generated using the SHA-1 hash function and the - secret as the HMAC key. - X-Hub-Signature is provided for compatibility with - existing integrations, and we recommend that you use the more - secure X-Hub-Signature-256 instead. -
    X-Hub-Signature-256 - This header is sent if the webhook is configured with a - secret. This is the HMAC hex digest of the request body, and is - generated using the SHA-256 hash function and the - secret as the HMAC key. -
    +
      +
    • + X-GitHub-Event: Name of the event that triggered the + delivery. +
      • +
    • + X-GitHub-Delivery: A + GUID + to identify the delivery. +
      • +
    • + X-GitHub-Enterprise-Version: The version of the GitHub + Enterprise Server instance that sent the HTTP POST payload. +
      • +
    • + X-GitHub-Enterprise-Host: The hostname of the GitHub + Enterprise Server instance that sent the HTTP POST payload. +
      • +
    • + X-Hub-Signature: This header is sent if the webhook is + configured with a + secret. This is the HMAC hex digest of the request body, and is generated + using the SHA-1 hash function and the secret as the HMAC + key. X-Hub-Signature is provided for + compatibility with existing integrations, and we recommend that you + use the more secure X-Hub-Signature-256 instead. +
      • +
    • + X-Hub-Signature-256: This header is sent if the webhook + is configured with a + secret. This is the HMAC hex digest of the request body, and is generated + using the SHA-256 hash function and the secret as the + HMAC key. +
      • +

    Also, the User-Agent for the requests will have the prefix GitHub-Hookshot/.

    -

    - - Example delivery +

    + Example delivery 

    > POST /payload HTTP/2
 
@@ -782,18982 +936,18600 @@ 
    
 >     ...
 >   }
 > }
    -

    - - branch_protection_rule -

    -

    - Activity related to a branch protection rule. For more information, see - "About branch protection rules." -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Administration repository permission -
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be created, - edited, or deleted. -
    ruleobject - 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. -
    changesobject - If the action was edited, the changes to the rule. -
    repositoryobject - The - repository +
    +
    +
    +

    + branch_protection_rule +

    +
    +
    + Activity related to a branch protection rule. For more + information, see "About branch protection rules." +
    +

    Availability for branch_protection_rule

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Administration repository + permission +
      • +
    +

    + Webhook payload object for branch_protection_rule +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created, + edited, or deleted. +
    +
    +
    +
    +
    +
    +
    rule object
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + If the action was edited, the changes + to the rule. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "edited", "rule": { "id": 21796960, "repository_id": + 259377789, "name": "production", "created_at": + "2021-08-19T12:16:32.000-04:00", "updated_at": + "2021-08-19T12:16:32.000-04:00", + "pull_request_reviews_enforcement_level": "off", + "required_approving_review_count": 1, + "dismiss_stale_reviews_on_push": false, + "require_code_owner_review": false, + "authorized_dismissal_actors_only": false, + "ignore_approvals_from_contributors": false, + "required_status_checks": [ "basic-CI" ], + "required_status_checks_enforcement_level": "non_admins", + "strict_required_status_checks_policy": false, + "signature_requirement_enforcement_level": "off", + "linear_history_requirement_enforcement_level": "off", + "admin_enforced": false, "allow_force_pushes_enforcement_level": + "off", "allow_deletions_enforcement_level": "off", + "merge_queue_enforcement_level": "off", + "required_deployments_enforcement_level": "off", + "required_conversation_resolution_level": "off", + "authorized_actors_only": true, "authorized_actor_names": [ + "Codertocat" ] }, "changes": { "authorized_actors_only": { "from": + false }, "authorized_actor_names": { "from": [] } }, "repository": + { "id": 17273051, "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", + "name": "octo-repo", "full_name": "octo-org/octo-repo", "private": + true, "owner": { "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "My first + repo on GitHub!", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2014-02-28T02:42:51Z", "updated_at": + "2021-03-11T14:54:13Z", "pushed_at": "2021-03-11T14:54:10Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "org-6811672@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 300, "stargazers_count": 0, "watchers_count": 0, "language": + "JavaScript", "has_issues": true, "has_projects": false, + "has_downloads": true, "has_wiki": false, "has_pages": true, + "forks_count": 0, "mirror_url": null, "archived": false, + "disabled": false, "open_issues_count": 39, "license": null, + "forks": 0, "open_issues": 39, "watchers": 0, "default_branch": + "main" }, "organization": { "login": "octo-org", "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "description": "Working better together!" }, "sender": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + cache_sync +

    +
    +
    + A Git ref has been successfully synced to a cache replica. For + more information, see "About repository caching." +
    +

    Availability for cache_sync

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for cache_sync

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "edited",
-  "rule": {
-    "id": 21796960,
-    "repository_id": 259377789,
-    "name": "production",
-    "created_at": "2021-08-19T12:16:32.000-04:00",
-    "updated_at": "2021-08-19T12:16:32.000-04:00",
-    "pull_request_reviews_enforcement_level": "off",
-    "required_approving_review_count": 1,
-    "dismiss_stale_reviews_on_push": false,
-    "require_code_owner_review": false,
-    "authorized_dismissal_actors_only": false,
-    "ignore_approvals_from_contributors": false,
-    "required_status_checks": [
-      "basic-CI"
-    ],
-    "required_status_checks_enforcement_level": "non_admins",
-    "strict_required_status_checks_policy": false,
-    "signature_requirement_enforcement_level": "off",
-    "linear_history_requirement_enforcement_level": "off",
-    "admin_enforced": false,
-    "allow_force_pushes_enforcement_level": "off",
-    "allow_deletions_enforcement_level": "off",
-    "merge_queue_enforcement_level": "off",
-    "required_deployments_enforcement_level": "off",
-    "required_conversation_resolution_level": "off",
-    "authorized_actors_only": true,
-    "authorized_actor_names": [
-      "Codertocat"
-    ]
-  },
-  "changes": {
-    "authorized_actors_only": {
-      "from": false
-    },
-    "authorized_actor_names": {
-      "from": []
-    }
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    + cache_location string +
    +
    +
    + The location of the cache server that has been + updated. +
    +
    +
    +
    +
    +
    +
    ref string
    +
    +
    The ref that has been updated.
    +
    +
    +
    +
    +
    +
    before string
    +
    +
    + The OID of the ref on the cache replica before it + was updated. +
    +
    +
    +
    +
    +
    +
    after string
    +
    +
    + The OID of the ref on the cache replica after the + update. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "cache_location": "morocco", "ref": "refs/heads/main", + "before": "0000000000000000000000000000000000000000", "after": + "de40facb99837f9ca38a0d399b0d20fe135510eb", "repository": { "id": + 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "github-enterprise", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": + "https://octocoders.github.io/api/v3/users/github-enterprise", + "html_url": "https://octocoders.github.io/github-enterprise", + "followers_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/github-enterprise/received_events", + "type": "User", "site_admin": false } } +
    +
    -

    - - cache_sync -

    -

    - A Git ref has been successfully synced to a cache replica. For more - information, see "About repository caching." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    cache_locationstringThe location of the cache server that has been updated.
    refstringThe ref that has been updated.
    beforestring - The OID of the ref on the cache replica before it was updated. -
    afterstringThe OID of the ref on the cache replica after the update.
    repositoryobject - The - repository +
    +

    + check_run +

    +
    +
    +

    + Note: The Checks API only looks for pushes in + the repository where the check suite or check run were 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. +

    + Check run activity has occurred. The type of activity is specified + in the action property of the payload object. For + more information, see the "check runs" REST API. +
    +

    Availability for check_run

    +
      +
    • + Repository webhooks only receive payloads for the + created and completed event types in a + repository +
      • +
    • + Organization webhooks only receive payloads for the + created and completed event types in + repositories +
      • +
    • + GitHub Apps with Checks read permission receive + payloads for the created and + completed events that occur in the repository where + the app is installed. The app must have + Checks write permission to receive the + rerequested and requested_action event + types. The rerequested and + requested_action event type payloads are only sent + to the GitHub App being requested. GitHub Apps with + Checks write permission are automatically + subscribed to this webhook event. +
      • +
    +

    Webhook payload object for check_run

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be one of: +
      +
    • + created - A new check run was + created. +
      • +
    • + completed - The + status of the check run is + completed. +
      • +
    • + rerequested - Someone requested to + re-run your check run from the pull request UI. + See "About status checks" for more details about the GitHub UI. When + you receive a rerequested action, + you'll need to + create a new check run. Only the GitHub App that someone requests to + re-run the check will receive the + rerequested payload. +
      • +
    • + requested_action - Someone + requested an action your app provides to be + taken. Only the GitHub App someone requests to + perform an action will receive the + requested_action payload. To learn + more about check runs and requested actions, see + "Check runs and requested actions." +
      • +
    +
    +
    +
    +
    +
    +
    +
    check_run object
    +
    +
    + The + check_run. +
    +
    +
    +
    +
    +
    +
    + check_run[status] string +
    +
    +
    + The current status of the check run. Can be + queued, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + check_run[conclusion] string +
    +
    +
    + The result of the completed check run. Can be one of + success, failure, + neutral, cancelled, + timed_out, + action_required or stale. + This value will be null until the check + run has completed. +
    +
    +
    +
    +
    +
    +
    + check_run[name] string +
    +
    +
    The name of the check run.
    +
    +
    +
    +
    +
    +
    + check_run[check_suite][id] + integer +
    +
    +
    + The id of the check suite that this check run is + part of. +
    +
    +
    +
    +
    +
    +
    + check_run[check_suite][pull_requests] + array +
    +
    +
    + An array of pull requests that match this check + suite. A pull request matches a check suite if they + have the same + head_branch.

    Note: +
      +
    • + The head_sha of the check suite can + differ from the sha of the pull + request if subsequent pushes are made into the + PR. +
      • +
    • + When the check suite's + head_branch is in a forked + repository it will be null and the + pull_requests array will be empty. +
      • +
    +
    +
    +
    +
    +
    +
    +
    + check_run[check_suite][deployment] + object +
    +
    +
    + A deployment to a repository environment. This will + only be populated if the check run was created by a + GitHub Actions workflow job that references an + environment. +
    +
    +
    +
    +
    +
    +
    + requested_action object +
    +
    +
    The action requested by the user.
    +
    +
    +
    +
    +
    +
    + requested_action[identifier] + string +
    +
    +
    + The integrator reference of the action requested by + the user. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "check_run": { "id": 2, "node_id": + "MDg6Q2hlY2tSdW4y", "head_sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "external_id": "", + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/runs/2", + "details_url": "https://octocoders.io", "status": "queued", + "conclusion": null, "started_at": "2019-05-15T19:39:04Z", + "completed_at": null, "output": { "title": null, "summary": null, + "text": null, "annotations_count": 0, "annotations_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2/annotations" + }, "name": "Octocoders-linter", "check_suite": { "id": 9, + "node_id": "MDEwOkNoZWNrU3VpdGU5", "head_branch": "changes", + "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1", "status": + "queued", "conclusion": null, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9", + "before": "4544205a385319fd846d5df4ed2e3b8173529d78", "after": + "14977a7b5485400124827221a04bfb474bcd72d1", "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ], "app": { "id": 2, "node_id": + "MDM6QXBwMg==", "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:38:27Z" }, + "app": { "id": 2, "node_id": "MDM6QXBwMg==", "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ] }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + check_suite +

    +
    +
    +

    + Note: The Checks API only looks for pushes in + the repository where the check suite or check run were 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. +

    + Check suite activity has occurred. The type of activity is + specified in the action property of the payload + object. For more information, see the "check suites" REST API. +
    +

    Availability for check_suite

    +
      +
    • + Repository webhooks only receive payloads for the + completed event types in a repository +
      • +
    • + Organization webhooks only receive payloads for the + completed event types in repositories +
      • +
    • + GitHub Apps with Checks read permission receive + payloads for the created and + completed events that occur in the repository where + the app is installed. The app must have + Checks write permission to receive the + requested and rerequested event types. + The requested and rerequested event + type payloads are only sent to the GitHub App being requested. + GitHub Apps with Checks write permission are + automatically subscribed to this webhook event. +
      • +
    +

    Webhook payload object for check_suite

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "cache_location": "morocco",
-  "ref": "refs/heads/main",
-  "before": "0000000000000000000000000000000000000000",
-  "after": "de40facb99837f9ca38a0d399b0d20fe135510eb",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "github-enterprise",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/github-enterprise",
-    "html_url": "https://octocoders.github.io/github-enterprise",
-    "followers_url": "https://octocoders.github.io/api/v3/users/github-enterprise/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/github-enterprise/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/github-enterprise/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/github-enterprise/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/github-enterprise/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/github-enterprise/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/github-enterprise/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/github-enterprise/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/github-enterprise/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be: +
      +
    • + completed - All check runs in a + check suite have completed. +
      • +
    • + requested - Occurs when new code is + pushed to the app's repository. When you receive + the requested action events, you'll + need to + create a new check run. +
      • +
    • + rerequested - Occurs when someone + requests to re-run the entire check suite from + the pull request UI. When you receive the + rerequested action events, you'll + need to + create a new check run. See "About status checks" for more details about the GitHub UI. +
      • +
    +
    +
    +
    +
    +
    +
    +
    check_suite object
    +
    +
    + The + check_suite. +
    +
    +
    +
    +
    +
    +
    + check_suite[head_branch] + string +
    +
    +
    The head branch name the changes are on.
    +
    +
    +
    +
    +
    +
    + check_suite[head_sha] string +
    +
    +
    + The SHA of the most recent commit for this check + suite. +
    +
    +
    +
    +
    +
    +
    + check_suite[status] string +
    +
    +
    + The summary status for all check runs that are part + of the check suite. Can be queued, + requested, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + check_suite[conclusion] + string +
    +
    +
    + The summary conclusion for all check runs that are + part of the check suite. Can be one of + success, failure, + neutral, cancelled, + timed_out, + action_required or stale. + This value will be null until the check + run has completed. +
    +
    +
    +
    +
    +
    +
    + check_suite[url] string +
    +
    +
    + URL that points to the check suite API resource. +
    +
    +
    +
    +
    +
    +
    + check_suite[pull_requests] + array +
    +
    +
    + An array of pull requests that match this check + suite. A pull request matches a check suite if they + have the same + head_branch.

    Note: +
      +
    • + The head_sha of the check suite can + differ from the sha of the pull + request if subsequent pushes are made into the + PR. +
      • +
    • + When the check suite's + head_branch is in a forked + repository it will be null and the + pull_requests array will be empty. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "completed", "check_suite": { "id": 9, "node_id": + "MDEwOkNoZWNrU3VpdGU5", "head_branch": "changes", "head_sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "status": "completed", + "conclusion": "success", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9", + "before": "4544205a385319fd846d5df4ed2e3b8173529d78", "after": + "14977a7b5485400124827221a04bfb474bcd72d1", "pull_requests": [ { + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "number": 2, "head": { "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } }, "base": { "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "repo": { "id": 118, + "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "name": "Hello-World" } } } ], "app": { "id": 2, "node_id": + "MDM6QXBwMg==", "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "name": + "octocoders-linter", "description": "", "external_url": + "https://octocoders.io", "html_url": + "https://octocoders.github.io/github-apps/octocoders-linter", + "created_at": "2019-05-15T15:41:35Z", "updated_at": + "2019-05-15T15:41:35Z", "permissions": { "administration": + "write", "checks": "write", "contents": "write", "deployments": + "write", "issues": "write", "metadata": "read", "pages": "write", + "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "vulnerability_alerts": "read", + "statuses": "write", "members": "write", + "organization_user_blocking": "write", "organization_projects": + "write", "team_discussions": "write", "organization_hooks": + "write", "repository_pre_receive_hooks": "write", + "organization_pre_receive_hooks": "write" }, "events": [ + "check_run", "check_suite", "commit_comment", "create", "delete", + "deployment", "deployment_status", "fork", "gollum", "issues", + "issue_comment", "label", "member", "membership", "milestone", + "organization", "page_build", "project", "project_card", + "project_column", "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ] }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:39:09Z", + "latest_check_runs_count": 1, "check_runs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs", + "head_commit": { "id": "14977a7b5485400124827221a04bfb474bcd72d1", + "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea", "message": + "Update README.md", "timestamp": "2019-05-15T19:38:01Z", "author": + { "name": "Codertocat", "email": "Codertocat@Octocoders.io" }, + "committer": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io" } } }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - check_run -

    -

    - Check run activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check runs" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    +
    +

    + code_scanning_alert +

    +
    +
    + Activity related to code scanning alerts in a repository. The type + of activity is specified in the action property of the payload + object. For more information, see "About code scanning." +
    +

    Availability for code_scanning_alert

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Code scanning alerts permission +
      • +
    +

    Webhook payload object for code_scanning_alert

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. This can be one of + created, reopened_by_user, + closed_by_user, fixed, + appeared_in_branch, or + reopened. +
    +
    +
    +
    +
    +
    +
    alert object
    +
    +
    + The code scanning alert involved in the event. +
    +
    +
    +
    +
    +
    +
    ref string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    commit_oid string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    + If the action is + reopened_by_user or + closed_by_user, the + sender object will be the user that + triggered the event. The sender object + is github-enterprise for all other + actions. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "reopened", "alert": { "number": 10, "created_at": + "2020-07-22T14:06:31Z", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10", + "instances": [ { "ref": "refs/heads/main", "analysis_key": + ".github/workflows/workflow.yml:upload", "environment": "{}", + "state": "open" } ], "state": "open", "dismissed_by": null, + "dismissed_at": null, "dismissed_reason": null, "rule": { "id": + "Style/FrozenStringLiteralComment", "severity": "note", + "description": "Add the frozen_string_literal comment to the top + of files to help transition to frozen string literals by default." + }, "tool": { "name": "Rubocop", "version": null } }, "ref": + "refs/heads/main", "commit_oid": + "d6e4c75c141dbacecc279b721b8b9393d5405795", "repository": { "id": + 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", "updated_at": + "2019-05-15T15:19:27Z", "pushed_at": "2019-05-15T15:20:32Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "main" }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • created - A new check run was created.
      • -
    • - completed - The status of the check - run is completed. -
      • -
    • - rerequested - Someone requested to re-run your - check run from the pull request UI. See "About status checks" for more details about the GitHub UI. When you receive a - rerequested action, you'll need to - create a new check run. Only the GitHub App that someone requests to re-run the - check will receive the rerequested payload. -
      • -
    • - requested_action - Someone requested an action - your app provides to be taken. Only the GitHub App someone - requests to perform an action will receive the - requested_action payload. To learn more about - check runs and requested actions, see "Check runs and requested actions." -
      • -
    -
    check_runobject - The - check_run. -
    check_run[status]string - The current status of the check run. Can be queued, - in_progress, or completed. -
    check_run[conclusion]string - The result of the completed check run. Can be one of - success, failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_run[name]stringThe name of the check run.
    check_run[check_suite][id]integerThe id of the check suite that this check run is part of.
    check_run[check_suite][pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    check_run[check_suite][deployment]object - A deployment to a repository environment. This will only be - populated if the check run was created by a GitHub Actions - workflow job that references an environment. -
    requested_actionobjectThe action requested by the user.
    requested_action[identifier]string - The integrator reference of the action requested by the user. -
    repositoryobject - The - repository +
    +

    + commit_comment +

    +
    +
    + A commit comment is created. The type of activity is specified in + the action property of the payload object. For more + information, see the "commit comment" REST API. +
    +

    Availability for commit_comment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for commit_comment

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    comment object
    +
    +
    + The + commit comment + resource. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2", + "id": 2, "node_id": "MDEzOkNvbW1pdENvbW1lbnQy", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "position": null, "line": + null, "path": null, "commit_id": + "4544205a385319fd846d5df4ed2e3b8173529d78", "created_at": + "2019-05-15T19:38:09Z", "updated_at": "2019-05-15T19:38:09Z", + "author_association": "OWNER", "body": "This is a really good + change! :+1:" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + create +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you create more than three tags at once. +

    + A Git branch or tag is created. For more information, see the "Git database" REST API. +
    +

    Availability for create

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for create

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "check_run": {
-    "id": 2,
-    "node_id": "MDg6Q2hlY2tSdW4y",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "external_id": "",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/runs/2",
-    "details_url": "https://octocoders.io",
-    "status": "queued",
-    "conclusion": null,
-    "started_at": "2019-05-15T19:39:04Z",
-    "completed_at": null,
-    "output": {
-      "title": null,
-      "summary": null,
-      "text": null,
-      "annotations_count": 0,
-      "annotations_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2/annotations"
-    },
-    "name": "Octocoders-linter",
-    "check_suite": {
-      "id": 9,
-      "node_id": "MDEwOkNoZWNrU3VpdGU5",
-      "head_branch": "changes",
-      "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "status": "queued",
-      "conclusion": null,
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-      "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-      "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "pull_requests": [
-        {
-          "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-          "id": 2,
-          "number": 2,
-          "head": {
-            "ref": "changes",
-            "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-            "repo": {
-              "id": 118,
-              "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          },
-          "base": {
-            "ref": "master",
-            "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-            "repo": {
-              "id": 118,
-              "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          }
-        }
-      ],
-      "app": {
-        "id": 2,
-        "node_id": "MDM6QXBwMg==",
-        "owner": {
-          "login": "Octocoders",
-          "id": 6,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-          "html_url": "https://octocoders.github.io/Octocoders",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "name": "octocoders-linter",
-        "description": "",
-        "external_url": "https://octocoders.io",
-        "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-        "created_at": "2019-05-15T15:41:35Z",
-        "updated_at": "2019-05-15T15:41:35Z",
-        "permissions": {
-          "administration": "write",
-          "checks": "write",
-          "contents": "write",
-          "deployments": "write",
-          "issues": "write",
-          "metadata": "read",
-          "pages": "write",
-          "pull_requests": "write",
-          "repository_hooks": "write",
-          "repository_projects": "write",
-          "vulnerability_alerts": "read",
-          "statuses": "write",
-          "members": "write",
-          "organization_user_blocking": "write",
-          "organization_projects": "write",
-          "team_discussions": "write",
-          "organization_hooks": "write",
-          "repository_pre_receive_hooks": "write",
-          "organization_pre_receive_hooks": "write"
-        },
-        "events": [
-          "check_run",
-          "check_suite",
-          "commit_comment",
-          "create",
-          "delete",
-          "deployment",
-          "deployment_status",
-          "fork",
-          "gollum",
-          "issues",
-          "issue_comment",
-          "label",
-          "member",
-          "membership",
-          "milestone",
-          "organization",
-          "page_build",
-          "project",
-          "project_card",
-          "project_column",
-          "public",
-          "pull_request",
-          "pull_request_review",
-          "pull_request_review_comment",
-          "push",
-          "release",
-          "repository",
-          "status",
-          "team",
-          "team_add",
-          "watch"
-        ]
-      },
-      "created_at": "2019-05-15T19:38:27Z",
-      "updated_at": "2019-05-15T19:38:27Z"
-    },
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ]
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    ref string
    +
    +
    + The + git ref + resource. +
    +
    +
    +
    +
    +
    +
    ref_type string
    +
    +
    + The type of Git ref object created in the + repository. Can be either branch or + tag. +
    +
    +
    +
    +
    +
    +
    + master_branch string +
    +
    +
    + The name of the repository's default branch (usually + main). +
    +
    +
    +
    +
    +
    +
    description string
    +
    +
    The repository's current description.
    +
    +
    +
    +
    +
    +
    pusher_type string
    +
    +
    + The pusher type for the event. Can be either + user or a deploy key. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "ref": "simple-tag", "ref_type": "tag", "master_branch": + "master", "description": null, "pusher_type": "user", + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:22Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - check_suite -

    -

    - Check suite activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check suites" REST API. -

    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    +
    +

    + delete +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you delete more than three tags at once. +

    + A Git branch or tag is deleted. For more information, see the "Git database" REST API. +
    +

    Availability for delete

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for delete

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    ref string
    +
    +
    + The + git ref + resource. +
    +
    +
    +
    +
    +
    +
    ref_type string
    +
    +
    + The type of Git ref object deleted in the + repository. Can be either branch or + tag. +
    +
    +
    +
    +
    +
    +
    pusher_type string
    +
    +
    + The pusher type for the event. Can be either + user or a deploy key. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "simple-tag", "ref_type": "tag", "pusher_type": "user", + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be: -
      -
    • - completed - All check runs in a check suite have - completed. -
      • -
    • - requested - Occurs when new code is pushed to the - app's repository. When you receive the - requested action events, you'll need to - create a new check run. -
      • -
    • - rerequested - Occurs when someone requests to - re-run the entire check suite from the pull request UI. When - you receive the rerequested action events, you'll - need to - create a new check run. See "About status checks" for more details about the GitHub UI. -
      • -
    -
    check_suiteobject - The - check_suite. -
    check_suite[head_branch]stringThe head branch name the changes are on.
    check_suite[head_sha]stringThe SHA of the most recent commit for this check suite.
    check_suite[status]string - The summary status for all check runs that are part of the check - suite. Can be queued, requested, - in_progress, or completed. -
    check_suite[conclusion]string - The summary conclusion for all check runs that are part of the - check suite. Can be one of success, - failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_suite[url]stringURL that points to the check suite API resource.
    check_suite[pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    repositoryobject - The - repository +
    +

    + deploy_key +

    +
    +
    + A deploy key is added or removed from a repository. The type of + activity is specified in the action property of the + payload object. For more information, see the "Deploy keys" REST API. +
    +

    Availability for deploy_key

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for deploy_key

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be either + created or deleted. +
    +
    +
    +
    +
    +
    +
    key object
    +
    +
    + The + deploy key + resource. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "key": { "id": 100, "key": "ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z", + "url": + "https://api.github.com/repos/Codertocat/Hello-World/keys/100", + "title": "hey-its-a-deploy-key", "verified": true, "created_at": + "2019-04-02T17:37:07Z", "read_only": true }, "repository": { "id": + 135493233, "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "owner": { + "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "private": false, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-05-30T20:18:04Z", "updated_at": + "2018-05-30T20:18:50Z", "pushed_at": "2018-05-30T20:18:48Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 1, "license": null, + "forks": 0, "open_issues": 1, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    + +
    +
    +

    + deployment +

    +
    +
    + A deployment is created. The type of activity is specified in the + action property of the payload object. For more + information, see the "deployment" REST API. +
    +

    Availability for deployment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Deployments permission
      • +
    +

    Webhook payload object for deployment

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "check_suite": {
-    "id": 9,
-    "node_id": "MDEwOkNoZWNrU3VpdGU5",
-    "head_branch": "changes",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "status": "completed",
-    "conclusion": "success",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-    "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:39:09Z",
-    "latest_check_runs_count": 1,
-    "check_runs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs",
-    "head_commit": {
-      "id": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
-      "message": "Update README.md",
-      "timestamp": "2019-05-15T19:38:01Z",
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@Octocoders.io"
-      },
-      "committer": {
-        "name": "Codertocat",
-        "email": "Codertocat@Octocoders.io"
-      }
-    }
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    deployment object
    +
    +
    + The + deployment. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "deployment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "id": 2, "node_id": "MDEwOkRlcGxveW1lbnQy", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "ref": "master", + "task": "deploy", "payload": {}, "original_environment": + "production", "environment": "production", "description": null, + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:20Z", "updated_at": "2019-05-15T19:38:20Z", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - code_scanning_alert -

    -

    - Activity related to code scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see "About code scanning." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - created, reopened_by_user, - closed_by_user, fixed, - appeared_in_branch, or reopened. -
    alertobjectThe code scanning alert involved in the event.
    refstring - 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. -
    commit_oidstring - 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. -
    repositoryobject - The - repository +
    +

    + deployment_status +

    +
    +
    + A deployment is created. The type of activity is specified in the + action property of the payload object. For more + information, see the "deployments" REST API. +
    +

    Availability for deployment_status

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Deployments permission
      • +
    +

    Webhook payload object for deployment_status

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created. +
    +
    +
    +
    +
    +
    +
    + deployment_status object +
    +
    +
    + The + deployment status. +
    +
    +
    +
    +
    +
    +
    + deployment_status["state"] + string +
    +
    +
    + The new state. Can be pending, + success, failure, or + error. +
    +
    +
    +
    +
    +
    +
    + deployment_status["target_url"] + string +
    +
    +
    The optional link added to the status.
    +
    +
    +
    +
    +
    +
    + deployment_status["description"] + string +
    +
    +
    + The optional human-readable description added to the + status. +
    +
    +
    +
    +
    +
    +
    deployment object
    +
    +
    + The + deployment + that this status is associated with. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "deployment_status": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2", + "id": 2, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy", "state": + "success", "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "description": "", + "environment": "production", "target_url": "", "created_at": + "2019-05-15T19:38:21Z", "updated_at": "2019-05-15T19:38:21Z", + "deployment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "deployment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2", + "id": 2, "node_id": "MDEwOkRlcGxveW1lbnQy", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "ref": "master", + "task": "deploy", "payload": {}, "original_environment": + "production", "environment": "production", "description": null, + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:20Z", "updated_at": "2019-05-15T19:38:21Z", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World" + }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + enterprise +

    +
    +
    + A site or repository administrator enables or disables anonymous + Git read access. See "Allowing admins to enable anonymous Git read access to public + repositories" for more details. This event is not available in the Events + API. +
    +

    Availability for enterprise

    +
      +
    • + GitHub Enterprise webhooks. For more information, "Global webhooks." +
      • +
    +

    Webhook payload object for enterprise

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is reopened_by_user or - closed_by_user, the sender object will - be the user that triggered the event. The - sender object is github-enterprise for - all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 10,
-    "created_at": "2020-07-22T14:06:31Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
-    "instances": [
-      {
-        "ref": "refs/heads/main",
-        "analysis_key": ".github/workflows/workflow.yml:upload",
-        "environment": "{}",
-        "state": "open"
-      }
-    ],
-    "state": "open",
-    "dismissed_by": null,
-    "dismissed_at": null,
-    "dismissed_reason": null,
-    "rule": {
-      "id": "Style/FrozenStringLiteralComment",
-      "severity": "note",
-      "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default."
-    },
-    "tool": {
-      "name": "Rubocop",
-      "version": null
-    }
-  },
-  "ref": "refs/heads/main",
-  "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be + anonymous_access_enabled or + anonymous_access_disabled. +
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "anonymous_access_enabled", "sender": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://avatars.octocoders.github.io/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": true } } +
    + -

    - - commit_comment -

    -

    - A commit comment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "commit comment" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    commentobject - The - commit comment +
    +

    + fork +

    +
    +
    + A user forks a repository. For more information, see the "forks" REST API. +
    +

    Availability for fork

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for fork

    +
    +
    + - resource. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    forkee object
    +
    +
    + The created + repository + resource. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "forkee": { "id": 120, "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=", + "name": "Hello-World", "full_name": "Octocoders/Hello-World", + "private": false, "owner": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master", "public": true }, "repository": { + "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "installation": { + "id": 5, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } + } +
    +
    + +
    +
    +

    + github_app_authorization +

    +
    +
    + When someone revokes their authorization of a GitHub App, this + event occurs. A GitHub App receives this webhook by default and + cannot unsubscribe from this event.Anyone 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 + user-to-server requests, which require GitHub App authorization, + see "Identifying and authorizing users for GitHub Apps." +
    +

    Availability for github_app_authorization

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for github_app_authorization +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be revoked. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "revoked", "sender": { "login": "octocat", "id": 1, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + gollum +

    +
    +
    + A wiki page is created or updated. For more information, see "About wikis." +
    +

    Availability for gollum

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for gollum

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2",
-    "id": 2,
-    "node_id": "MDEzOkNvbW1pdENvbW1lbnQy",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "position": null,
-    "line": null,
-    "path": null,
-    "commit_id": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "created_at": "2019-05-15T19:38:09Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "author_association": "OWNER",
-    "body": "This is a really good change! :+1:"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    pages array
    +
    +
    The pages that were updated.
    +
    +
    +
    +
    +
    +
    + pages[][page_name] string +
    +
    +
    The name of the page.
    +
    +
    +
    +
    +
    +
    + pages[][title] string +
    +
    +
    The current page title.
    +
    +
    +
    +
    +
    +
    + pages[][action] string +
    +
    +
    + The action that was performed on the page. Can be + created or edited. +
    +
    +
    +
    +
    +
    +
    pages[][sha] string
    +
    +
    The latest commit SHA of the page.
    +
    +
    +
    +
    +
    +
    + pages[][html_url] string +
    +
    +
    Points to the HTML wiki page.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "pages": [ { "page_name": "Home", "title": "Home", "summary": + null, "action": "edited", "sha": + "4bbb6df16cb5ce1818602bf634e94ebdac7ae385", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home" } + ], "repository": { "id": 122, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjI=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "owner": { "login": "Codertocat", "id": + 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://avatars.octocoders.github.io/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "private": false, + "html_url": "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-10-04T18:29:19Z", "updated_at": + "2018-10-04T18:29:21Z", "pushed_at": "2018-10-04T18:29:59Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 0, "license": null, + "forks": 0, "open_issues": 0, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "rachmari", "id": 3, "node_id": + "MDQ6VXNlcjM=", "avatar_url": + "https://avatars.octocoders.github.io/u/3?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/rachmari", + "html_url": "https://octocoders.github.io/rachmari", + "followers_url": + "https://octocoders.github.io/api/v3/users/rachmari/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/rachmari/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/rachmari/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/rachmari/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/rachmari/received_events", + "type": "User", "site_admin": true } } +
    + -

    - - create -

    -

    - A Git branch or tag is created. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you create more than three tags at once. -

    +
    +

    + installation +

    +
    +
    + Activity related to a GitHub App installation. The type of + activity is specified in the action property of the + payload object. For more information, see the "GitHub App installation" REST API. +
    +

    Availability for installation

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for installation

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + created - Someone installs a GitHub + App. +
      • +
    • + deleted - Someone uninstalls a + GitHub App +
      • +
    • + suspend - Someone suspends a GitHub + App installation. +
      • +
    • + unsuspend - Someone unsuspends a + GitHub App installation. +
      • +
    • + new_permissions_accepted - Someone + accepts new permissions for a GitHub App + installation. When a GitHub App owner requests + new permissions, the person who installed the + GitHub App must accept the new permissions + request. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repositories array
    +
    +
    + An array of repository objects that the installation + can access. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    The GitHub App installation.
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "deleted", "installation": { "id": 5, "account": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?", + "gravatar_id": "", "url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat", + "followers_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers", + "following_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs", + "repos_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos", + "events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repository_selection": + "selected", "access_tokens_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens", + "repositories_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5", + "app_id": 2, "target_id": 4, "target_type": "User", "permissions": + { "administration": "write", "checks": "write", "contents": + "write", "deployments": "write", "issues": "write", "pages": + "write", "pull_requests": "write", "repository_hooks": "write", + "repository_projects": "write", "statuses": "write", + "repository_pre_receive_hooks": "write", "metadata": "read", + "vulnerability_alerts": "read" }, "events": [ "check_run", + "check_suite", "commit_comment", "create", "delete", "deployment", + "deployment_status", "fork", "gollum", "issues", "issue_comment", + "label", "member", "membership", "milestone", "organization", + "page_build", "project", "project_card", "project_column", + "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ], "created_at": + "2019-05-15T19:37:38.000Z", "updated_at": + "2019-05-15T19:37:38.000Z", "single_file_name": null }, + "enterprise": { "id": 1, "slug": "github", "name": "GitHub", + "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github", + "created_at": "2019-05-14T19:31:12Z", "updated_at": + "2019-05-14T19:31:12Z" }, "sender": { "login": "Codertocat", "id": + 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?", + "gravatar_id": "", "url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat", + "html_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat", + "followers_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers", + "following_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs", + "repos_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos", + "events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    refstring - The - git ref +
    +

    + installation_repositories +

    +
    +
    + Activity related to repositories being added to a GitHub App + installation. The type of activity is specified in the + action property of the payload object. For more + information, see the "GitHub App installation" REST API. +
    +

    Availability for installation_repositories

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for installation_repositories +

    +
    +
    + - resource. - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ref_typestring - The type of Git ref object created in the repository. Can be - either branch or tag. -
    master_branchstring - The name of the repository's default branch (usually - main). -
    descriptionstringThe repository's current description.
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be either + added or removed. +
    +
    +
    +
    +
    +
    +
    + repository_selection string +
    +
    +
    + The choice of repositories the installation is on. + Can be either selected or + all. +
    +
    +
    +
    +
    +
    +
    + repositories_added array +
    +
    +
    + An array of repository objects, which were added to + the installation. +
    +
    +
    +
    +
    +
    +
    + repositories_removed array +
    +
    +
    + An array of repository objects, which were removed + from the installation. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    The GitHub App installation.
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added", "installation": { "id": 5, "account": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repository_selection": + "selected", "access_tokens_url": + "https://octocoders.github.io/api/v3/app/installations/5/access_tokens", + "repositories_url": + "https://octocoders.github.io/api/v3/installation/repositories", + "html_url": + "https://octocoders.github.io/settings/installations/5", "app_id": + 2, "target_id": 4, "target_type": "User", "permissions": { + "administration": "write", "repository_pre_receive_hooks": + "write", "statuses": "write", "repository_projects": "write", + "repository_hooks": "write", "pull_requests": "write", "pages": + "write", "issues": "write", "deployments": "write", "contents": + "write", "checks": "write", "vulnerability_alerts": "read", + "metadata": "read" }, "events": [ "check_run", "check_suite", + "commit_comment", "create", "delete", "deployment", + "deployment_status", "fork", "gollum", "issues", "issue_comment", + "label", "member", "membership", "milestone", "organization", + "page_build", "project", "project_card", "project_column", + "public", "pull_request", "pull_request_review", + "pull_request_review_comment", "push", "release", "repository", + "status", "team", "team_add", "watch" ], "created_at": 1557949058, + "updated_at": 1557949058, "single_file_name": null }, + "repository_selection": "selected", "repositories_added": [ { + "id": 119, "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=", "name": "Space", + "full_name": "Codertocat/Space", "private": false } ], + "repositories_removed": [], "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    + +
    +
    +

    + issue_comment +

    +
    +
    + Activity related to an issue or pull request comment. The type of + activity is specified in the action property of the + payload object. For more information, see the "issue comments" REST API. +
    +

    Availability for issue_comment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Issues permission
      • +
    +

    Webhook payload object for issue_comment

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the comment. Can be + one of created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    issue object
    +
    +
    + The + issue + the comment belongs to. +
    +
    +
    +
    +
    +
    +
    comment object
    +
    +
    + The + comment + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "issue": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1", + "id": 10, "node_id": "MDU6SXNzdWUxMA==", "number": 1, "title": + "Spelling error in the README file", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "labels": [ { "id": 941, + "node_id": "MDU6TGFiZWw5NDE=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", "color": "d73a4a", "default": true } ], "state": + "open", "locked": false, "assignee": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "assignees": [ { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } ], "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 1, + "closed_issues": 0, "state": "closed", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:53Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": + "2019-05-15T19:37:53Z" }, "comments": 0, "created_at": + "2019-05-15T19:37:53Z", "updated_at": "2019-05-15T19:37:55Z", + "closed_at": null, "author_association": "OWNER", "body": "It + looks like you accidently spelled 'commit' with two 't's." }, + "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "id": 2, "node_id": "MDEyOklzc3VlQ29tbWVudDI=", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:37:55Z", "updated_at": "2019-05-15T19:37:55Z", + "author_association": "OWNER", "body": "You are totally right! + I'll get this fixed right away." }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 1, + "license": null, "forks": 0, "open_issues": 1, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + issues +

    +
    +
    + Activity related to an issue. The type of activity is specified in + the action property of the payload object. For more + information, see the "issues" REST API. +
    +

    Availability for issues

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Issues permission
      • +
    +

    Webhook payload object for issues

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "master_branch": "master",
-  "description": null,
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:22Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + opened, edited, + deleted, pinned, + unpinned, closed, + reopened, assigned, + unassigned, labeled, + unlabeled, locked, + unlocked, transferred, + milestoned, or + demilestoned. +
    +
    +
    +
    +
    +
    +
    issue object
    +
    +
    + The + issue + itself. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the issue if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from] string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    assignee object
    +
    +
    + The optional user who was assigned or unassigned + from the issue. +
    +
    +
    +
    +
    +
    +
    label object
    +
    +
    + The optional label that was added or removed from + the issue. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "edited", "issue": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1", + "repository_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/issues/1", + "id": 10, "node_id": "MDU6SXNzdWUxMA==", "number": 1, "title": + "Spelling error in the README file", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "labels": [ { "id": 941, + "node_id": "MDU6TGFiZWw5NDE=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", "color": "d73a4a", "default": true } ], "state": + "open", "locked": false, "assignee": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "assignees": [ { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } ], "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 1, + "closed_issues": 0, "state": "closed", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:53Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": + "2019-05-15T19:37:53Z" }, "comments": 0, "created_at": + "2019-05-15T19:37:53Z", "updated_at": "2019-05-15T19:37:54Z", + "closed_at": null, "author_association": "OWNER", "body": "It + looks like you accidently spelled 'commit' with two 't's." }, + "changes": {}, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 1, + "license": null, "forks": 0, "open_issues": 1, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - delete -

    -

    - A Git branch or tag is deleted. For more information, see the "Git database" REST API. -

    -

    - Note: You will not receive a webhook for this event - when you delete more than three tags at once. -

    +
    +

    + label +

    +
    +
    + Activity related to a label. The type of activity is specified in + the action property of the payload object. For more + information, see the "labels" REST API. +
    +

    Availability for label

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object for label

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be + created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    label object
    +
    +
    The label that was added.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the label if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[color][from] string +
    +
    +
    + The previous version of the color if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "deleted", "label": { "id": 965, "node_id": + "MDU6TGFiZWw5NjU=", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix", + "name": ":bug: Bugfix", "color": "cceeaa", "default": false }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    refstring - The - git ref +
    +

    + member +

    +
    +
    + Activity related to repository collaborators. The type of activity + is specified in the action property of the payload + object. For more information, see the "collaborators" REST API. +
    +

    Availability for member

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for member

    +
    +
    + - resource. - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ref_typestring - The type of Git ref object deleted in the repository. Can be - either branch or tag. -
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + added - A user accepts an + invitation to a repository. +
      • +
    • + removed - A user is removed as a + collaborator in a repository. +
      • +
    • + edited - A user's collaborator + permissions have changed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    member object
    +
    +
    + The + user + that was added. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the collaborator permissions if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[old_permission][from] + string +
    +
    +
    + The previous permissions of the collaborator if the + action was edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added", "member": { "login": "Hacktocat", "id": 5, + "node_id": "MDQ6VXNlcjU=", "avatar_url": + "https://octocoders.github.io/avatars/u/5?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Hacktocat", + "html_url": "https://octocoders.github.io/Hacktocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/received_events", + "type": "User", "site_admin": false }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + membership +

    +
    +
    + Activity related to team membership. The type of activity is + specified in the action property of the payload + object. For more information, see the "team members" REST API. +
    +

    Availability for membership

    +
      +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for membership

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be + added or removed. +
    +
    +
    +
    +
    +
    +
    scope string
    +
    +
    + The scope of the membership. Currently, can only be + team. +
    +
    +
    +
    +
    +
    +
    member object
    +
    +
    + The + user + that was added or removed. +
    +
    +
    +
    +
    +
    +
    team object
    +
    +
    + The + team + for the membership. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "removed", "scope": "team", "member": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "sender": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "team": { "name": "github", + "id": 3, "node_id": "MDQ6VGVhbTM=", "slug": "github", + "description": "Open-source team", "privacy": "secret", "url": + "https://octocoders.github.io/api/v3/teams/3", "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "organization": { "login": "Octocoders", "id": 6, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" } + } +
    +
    +
    +
    +
    +

    + meta +

    +
    +
    + The webhook this event is configured on was deleted. This event + will only listen for changes to the particular hook the event is + installed on. Therefore, it must be selected for each hook that + you'd like to receive meta events for. +
    +

    Availability for meta

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for meta

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be deleted. +
    +
    +
    +
    +
    +
    +
    hook_id integer
    +
    +
    The id of the modified webhook.
    +
    +
    +
    +
    +
    +
    hook object
    +
    +
    + The modified webhook. This will contain different + keys based on the type of webhook it is: repository, + organization, business, app, or GitHub Marketplace. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "deleted", "hook_id": 101047067, "hook": { "type": + "Repository", "id": 101047067, "name": "web", "active": true, + "events": [ "meta" ], "config": { "content_type": "json", + "insecure_ssl": "0", "url": "http://example.com/hook" }, + "updated_at": "2019-04-10T03:57:12Z", "created_at": + "2019-04-10T03:57:12Z" }, "repository": { "id": 135493233, + "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "owner": { + "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "private": false, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2018-05-30T20:18:04Z", "updated_at": + "2018-05-30T20:18:50Z", "pushed_at": "2018-05-30T20:18:48Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "open_issues_count": 1, "license": null, + "forks": 0, "open_issues": 1, "watchers": 0, "default_branch": + "master" }, "sender": { "login": "Codertocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    + -

    - - deploy_key -

    -

    - A deploy key is added or removed from a repository. The type of activity - is specified in the action property of the payload object. - For more information, see the "Deploy keys" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be either created or - deleted. -
    keyobject - The - deploy key +
    +

    + milestone +

    +
    +
    + Activity related to milestones. The type of activity is specified + in the action property of the payload object. For + more information, see the "milestones" REST API. +
    +

    Availability for milestone

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object for milestone

    +
    +
    + - resource. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + created, closed, + opened (a closed milestone is + re-opened), edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    milestone object
    +
    +
    The milestone itself.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the milestone if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[description][from] + string +
    +
    +
    + The previous version of the description if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[due_on][from] string +
    +
    +
    + The previous version of the due date if the action + was edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from] string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "milestone": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/milestone/1", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 2, "node_id": "MDk6TWlsZXN0b25lMg==", "number": 1, "title": + "v1.0", "description": "Add new space flight simulator", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "open_issues": 0, + "closed_issues": 0, "state": "open", "created_at": + "2019-05-15T19:37:52Z", "updated_at": "2019-05-15T19:37:52Z", + "due_on": "2019-05-23T00:00:00Z", "closed_at": null }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:37:50Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + organization +

    +
    +
    + Activity related to an organization and its members. The type of + activity is specified in the action property of the + payload object. For more information, see the "organizations" REST API. +
    +

    Availability for organization

    +
      +
    • + GitHub Enterprise webhooks only receive created and + deleted events. For more information, "Global webhooks. +
      • +
    • + Organization webhooks only receive the deleted, + added, removed, renamed, + and invited events +
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for organization

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: + created, deleted, + renamed, member_added, + member_removed, or + member_invited. +
    +
    +
    +
    +
    +
    +
    invitation object
    +
    +
    + The invitation for the user or email if the action + is member_invited. +
    +
    +
    +
    +
    +
    +
    membership object
    +
    +
    + The membership between the user and the + organization. Not present when the action is + member_invited. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "member_added", "membership": { "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat", + "state": "active", "role": "member", "organization_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", "user": { + "login": "Hacktocat", "id": 5, "node_id": "MDQ6VXNlcjU=", + "avatar_url": "https://octocoders.github.io/avatars/u/5?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Hacktocat", "html_url": + "https://octocoders.github.io/Hacktocat", "followers_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Hacktocat/received_events", + "type": "User", "site_admin": false } }, "organization": { + "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "url": + "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + package +

    +
    +
    + Activity related to GitHub Packages. The type of activity is + specified in the action property of the payload + object. For more information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. +
    +

    Availability for package

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for package

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "key": {
-    "id": 100,
-    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100",
-    "title": "hey-its-a-deploy-key",
-    "verified": true,
-    "created_at": "2019-04-02T17:37:07Z",
-    "read_only": true
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be + published or updated. +
    +
    +
    +
    +
    +
    +
    package object
    +
    +
    Information about the package.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "published", "package": { "id": 10696, "name": + "hello-world-npm", "namespace": "Codertocat/hello-world-npm", + "description": null, "ecosystem": "docker", "package_type": "npm", + "html_url": + "https://github.com/Codertocat/hello-world-npm/packages/10696", + "created_at": "2019-05-09T23:28:29Z", "updated_at": + "2019-05-09T23:28:29Z", "owner": { "login": "Codertocat", "id": + 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "package_version": { "id": 24147, + "version": "1.0.0", "summary": "A simple npm package to + demonstrate GitHub Packages", "name": + "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "description": "", "body": "# hello-world-npm\n\nThis is a simple + npm package that demonstrates the [Github + Packages](https://github.com/features/package).\n\n## Installation + \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = + require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n", + "body_html": "<h1>hello-world-npm</h1>\n<p>This + is a simple npm package that demonstrates the <a + href=\"https://github.com/features/package\">Github Package + Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ + npm + install</code></p>\n<h2>Usage</h2>\n<pre><code>const + myPackage = + require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>", + "release": { "url": + "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286", + "html_url": + "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0", + "id": 17264286, "tag_name": "1.0.0", "target_commitish": "master", + "name": "1.0.0", "draft": false, "author": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "prerelease": false, "created_at": + "2019-05-09T23:24:40Z", "published_at": "2019-05-09T23:26:59Z" }, + "manifest": + "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A + simple npm package to demonstrate GitHub Package + Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo + \\\"Error: no test specified\\\" \\u0026\\u0026 exit + 1\"},\"version\":\"1.0.0\"}", "html_url": + "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0", + "tag_name": "1.0.0", "target_commitish": "master", "target_oid": + "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", "draft": false, + "prerelease": false, "created_at": "2019-05-09T23:28:29Z", + "updated_at": "2019-05-09T23:28:30Z", "metadata": [], + "docker_metadata": [], "package_files": [ { "download_url": + "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream", + "id": 92167, "name": "hello-world-npm-1.0.0-npm.tgz", "sha256": + "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8", + "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb", "md5": + "56ebbd5a5a03367f62d0c732bafd3c66", "content_type": + "application/octet-stream", "state": "uploaded", "size": 654, + "created_at": "2019-05-09T23:28:30Z", "updated_at": + "2019-05-09T23:28:30Z" } ], "author": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "source_url": + "ghcr.io/Codertocat/hello-world-npm/image-1:v1", + "installation_command": "npm install @Codertocat/@1.0.0" }, + "registry": { "about_url": + "https://help.github.com/about-github-packages", "name": "GitHub + npm registry", "type": "npm", "url": + "https://npm.pkg.github.com/@Codertocat", "vendor": "GitHub Inc" } + }, "repository": { "id": 185882436, "node_id": + "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=", "name": "hello-world-npm", + "full_name": "Codertocat/hello-world-npm", "private": true, + "owner": { "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "html_url": + "https://github.com/Codertocat/hello-world-npm", "description": + null, "fork": false, "url": + "https://api.github.com/repos/Codertocat/hello-world-npm", + "forks_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/hello-world-npm/deployments", + "created_at": "2019-05-09T22:53:26Z", "updated_at": + "2019-05-09T23:24:42Z", "pushed_at": "2019-05-09T23:27:00Z", + "git_url": "git://github.com/Codertocat/hello-world-npm.git", + "ssh_url": "git@github.com:Codertocat/hello-world-npm.git", + "clone_url": "https://github.com/Codertocat/hello-world-npm.git", + "svn_url": "https://github.com/Codertocat/hello-world-npm", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    + -

    - - deployment -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployment" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deploymentobject - The - deployment. -
    repositoryobject - The - repository +
    +

    + page_build +

    +
    +
    + Represents an attempted build of a GitHub Pages site, whether + successful or not. A push to a GitHub Pages enabled branch (gh-pages - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization +

    Availability for page_build

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Pages permission
      • +
    +

    Webhook payload object for page_build

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:20Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    id integer
    +
    +
    The unique identifier of the page build.
    +
    +
    +
    +
    +
    +
    build object
    +
    +
    + The + List GitHub Pages builds + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "id": 7, "build": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7", + "status": "built", "error": { "message": null }, "pusher": { + "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "commit": + "3648135c2986115284ae152d90459473b15fd19c", "duration": 6917, + "created_at": "2019-05-15T19:38:15Z", "updated_at": + "2019-05-15T19:38:22Z" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - deployment_status -

    -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deployment_statusobject - The - deployment status. -
    deployment_status["state"]string - The new state. Can be pending, success, - failure, or error. -
    deployment_status["target_url"]stringThe optional link added to the status.
    deployment_status["description"]string - The optional human-readable description added to the status. -
    deploymentobject - The +
    +
    +

    + ping +

    +
    +
    + When you create a new webhook, we'll send you a simple + ping event to let you know you've set up the webhook + correctly. This event isn't stored so it isn't retrievable via the deploymentEvents API - that this status is associated with. -
    repositoryobject - The - repository +

    Availability for ping

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps receive a ping event with an + app_id used to register the app +
      • +
    +

    Webhook payload object for ping

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    zen string
    +
    +
    Random string of GitHub zen.
    +
    +
    +
    +
    +
    +
    hook_id integer
    +
    +
    + The ID of the webhook that triggered the ping. +
    +
    +
    +
    +
    +
    +
    hook object
    +
    + +
    +
    +
    +
    +
    +
    + hook[app_id] integer +
    +
    +
    + When you register a new GitHub App, GitHub + Enterprise Server sends a ping event to the + webhook URL you specified during + registration. The event contains the + app_id, which is required for + authenticating + an app. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "zen": "Non-blocking is better than blocking.", "hook_id": 30, + "hook": { "type": "Repository", "id": 30, "name": "web", "active": + true, "events": [ "*" ], "config": { "content_type": "json", + "url": "https://smee.io/YEbF2t8kjvPAn7Ck", "insecure_ssl": "0" }, + "updated_at": "2019-05-15T19:38:17Z", "created_at": + "2019-05-15T19:38:17Z", "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30", + "test_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test", + "ping_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings", + "last_response": { "code": null, "status": "unused", "message": + null } }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    + + +
    +
    +

    + project +

    +
    +
    + Activity related to project boards. The type of activity is + specified in the action property of the payload + object. For more information, see the "projects" REST API. +
    +

    Availability for project

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object for project

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "deployment_status": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2",
-    "id": 2,
-    "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy",
-    "state": "success",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "description": "",
-    "environment": "production",
-    "target_url": "",
-    "created_at": "2019-05-15T19:38:21Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "deployment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the project. Can be + one of created, edited, + closed, reopened, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the project if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    project object
    +
    +
    + The + project + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "created", "project": { "owner_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "url": "https://octocoders.github.io/api/v3/projects/6", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/projects/1", + "columns_url": + "https://octocoders.github.io/api/v3/projects/6/columns", "id": 6, + "node_id": "MDc6UHJvamVjdDY=", "name": "Space 2.0", "body": + "Project tasks for a trip to Space", "number": 1, "state": "open", + "creator": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:38:27Z", "updated_at": "2019-05-15T19:38:27Z" }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - enterprise -

    -

    - A site or repository administrator enables or disables anonymous Git - read access. See "Allowing admins to enable anonymous Git read access to public - repositories" for more details. This event is not available in the Events API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be - anonymous_access_enabled or - anonymous_access_disabled. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "anonymous_access_enabled",
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    +
    +

    + project_card +

    +
    +
    + Activity related to cards in a project board. The type of activity + is specified in the action property of the payload + object. For more information, see the "project cards" REST API. +
    +

    Availability for project_card

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object for project_card

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed on the project card. Can be + created, edited, + moved, converted, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the project card if the action was + edited or converted. +
    +
    +
    +
    +
    +
    +
    + changes[note][from] string +
    +
    +
    + The previous version of the note if the action was + edited or converted. +
    +
    +
    +
    +
    +
    +
    after_id integer
    +
    +
    + The id of the card that this card now follows if the + action was "moved". Will be null if it + is the first card in a column. +
    +
    +
    +
    +
    +
    +
    project_card object
    +
    +
    + The + project card + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "project_card": { "url": + "https://octocoders.github.io/api/v3/projects/columns/cards/8", + "project_url": "https://octocoders.github.io/api/v3/projects/6", + "column_url": + "https://octocoders.github.io/api/v3/projects/columns/8", + "column_id": 8, "id": 8, "node_id": "MDExOlByb2plY3RDYXJkOA==", + "note": "Work that can be completed in one hour or less.", + "archived": false, "creator": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "created_at": + "2019-05-15T19:39:01Z", "updated_at": "2019-05-15T19:39:01Z" }, + "repository": { "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", + "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    -

    - - fork -

    -

    - A user forks a repository. For more information, see the "forks" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    forkeeobject - The created - repository +
    +

    + project_column +

    +
    +
    + Activity related to columns in a project board. The type of + activity is specified in the action property of the + payload object. For more information, see the "project columns" REST API. +
    +

    Availability for project_column

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Projects repository or + organization permission +
      • +
    +

    Webhook payload object for project_column

    +
    +
    + - resource. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the project column. + Can be one of created, + edited, moved or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the project column if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    after_id integer
    +
    +
    + The id of the column that this column now follows if + the action was "moved". Will be null if + it is the first column in a project. +
    +
    +
    +
    +
    +
    +
    + project_column object +
    +
    +
    + The + project column + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "project_column": { "url": + "https://octocoders.github.io/api/v3/projects/columns/8", + "project_url": "https://octocoders.github.io/api/v3/projects/6", + "cards_url": + "https://octocoders.github.io/api/v3/projects/columns/8/cards", + "id": 8, "node_id": "MDEzOlByb2plY3RDb2x1bW44", "name": "Small + bugfixes", "created_at": "2019-05-15T19:39:01Z", "updated_at": + "2019-05-15T19:39:01Z" }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:27Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + public +

    +
    +
    + When a private repository is made public. Without a doubt: the + best GitHub Enterprise Server event. +
    +

    Availability for public

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object for public

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    +
    +
    +
    +

    + pull_request +

    +
    +
    + Activity related to pull requests. The type of activity is + specified in the action property of the payload + object. For more information, see the "pull requests" REST API. +
    +

    Availability for pull_request

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object for pull_request

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "forkee": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "public": true
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • assigned
      • +
    • auto_merge_disabled
      • +
    • auto_merge_enabled
      • +
    • + closed: If the action is + closed and the + merged key is false, + the pull request was closed with unmerged + commits. If the action is + closed and the + merged key is true, + the pull request was merged. +
      • +
    • converted_to_draft
      • +
    • edited
      • +
    • labeled
      • +
    • locked
      • +
    • opened
      • +
    • ready_for_review
      • +
    • reopened
      • +
    • review_request_removed
      • +
    • review_requested
      • +
    • + synchronize: Triggered when a pull + request's head branch is updated. For example, + when the head branch is updated from the base + branch, when new commits are pushed to the head + branch, or when the base branch is changed. +
      • +
    • unassigned
      • +
    • unlabeled
      • +
    • unlocked
      • +
    +
    +
    +
    +
    +
    +
    +
    number integer
    +
    +
    The pull request number.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[title][from] string +
    +
    +
    + The previous version of the title if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + + -

    - - github_app_authorization -

    -

    - When someone revokes their authorization of a GitHub App, this event - occurs. A GitHub App receives this webhook by default and cannot - unsubscribe from this event. -

    -

    - Anyone 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 user-to-server requests, which require GitHub App - authorization, see "Identifying and authorizing users for GitHub Apps." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be revoked.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "revoked",
-  "sender": {
-    "login": "octocat",
-    "id": 1,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + pull_request_review +

    +
    +
    + Activity related to pull request reviews. The type of activity is + specified in the action property of the payload + object. For more information, see the "pull request reviews" REST API. +
    +

    Availability for pull_request_review

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    Webhook payload object for pull_request_review

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + submitted - A pull request review + is submitted into a non-pending state. +
      • +
    • + edited - The body of a review has + been edited. +
      • +
    • + dismissed - A review has been + dismissed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + the review pertains to. +
    +
    +
    +
    +
    +
    +
    review object
    +
    +
    The review that was affected.
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "submitted", "review": { "id": 2, "node_id": + "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": null, "commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "submitted_at": + "2019-05-15T19:38:08Z", "state": "commented", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2", + "pull_request_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", "_links": { "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2" + }, "pull_request": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + } } }, "pull_request": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2", + "diff_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff", + "patch_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2", + "number": 2, "state": "open", "locked": false, "title": "Update + the README with new information.", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "This is a pretty + simple change that we need to pull into master.", "created_at": + "2019-05-15T19:38:02Z", "updated_at": "2019-05-15T19:38:08Z", + "closed_at": null, "merged_at": null, "merge_commit_sha": + "e67e14475991deeb61cc1999c3bf9db333ac0d5f", "assignee": null, + "assignees": [], "requested_reviewers": [], "requested_teams": [], + "labels": [], "milestone": null, "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1", + "head": { "label": "Codertocat:changes", "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "base": { "label": + "Codertocat:master", "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2" }, + "issue": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2" + }, "comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments" + }, "review_comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments" + }, "review_comment": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}" + }, "commits": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits" + }, "statuses": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1" + } }, "author_association": "OWNER" }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - gollum -

    -

    - A wiki page is created or updated. For more information, see "About wikis." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    pagesarrayThe pages that were updated.
    pages[][page_name]stringThe name of the page.
    pages[][title]stringThe current page title.
    pages[][action]string - The action that was performed on the page. Can be - created or edited. -
    pages[][sha]stringThe latest commit SHA of the page.
    pages[][html_url]stringPoints to the HTML wiki page.
    repositoryobject - The - repository +
    +

    + pull_request_review_comment +

    +
    +
    + Activity related to pull request review comments in the pull + request's unified diff. The type of activity is specified in the + action property of the payload object. For more + information, see the "pull request review comments" REST API. +
    +

    Availability for pull_request_review_comment

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    + Webhook payload object for + pull_request_review_comment +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed on the comment. Can be + one of created, edited, or + deleted. +
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the comment if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + the comment belongs to. +
    +
    +
    +
    +
    +
    +
    comment object
    +
    +
    + The + comment + itself. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "comment": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2", + "pull_request_review_id": 2, "id": 2, "node_id": + "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=", "diff_hunk": "@@ -1 +1 + @@\n-# Hello-World", "path": "README.md", "position": 1, + "original_position": 1, "commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "original_commit_id": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "Maybe you should + use more emoji on this line.", "created_at": + "2019-05-15T19:38:07Z", "updated_at": "2019-05-15T19:38:08Z", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2", + "pull_request_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2" + }, "pull_request": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + } } }, "pull_request": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2", + "id": 2, "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==", "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2", + "diff_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff", + "patch_url": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch", + "issue_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2", + "number": 2, "state": "open", "locked": false, "title": "Update + the README with new information.", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "body": "This is a pretty + simple change that we need to pull into master.", "created_at": + "2019-05-15T19:38:02Z", "updated_at": "2019-05-15T19:38:08Z", + "closed_at": null, "merged_at": null, "merge_commit_sha": + "e67e14475991deeb61cc1999c3bf9db333ac0d5f", "assignee": null, + "assignees": [], "requested_reviewers": [], "requested_teams": [], + "labels": [], "milestone": null, "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1", + "head": { "label": "Codertocat:changes", "ref": "changes", "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "base": { "label": + "Codertocat:master", "ref": "master", "sha": + "78a96099c3f442d7f6e8d1a7d07090091993e65a", "user": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "repo": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2" + }, "html": { "href": + "https://octocoders.github.io/Codertocat/Hello-World/pull/2" }, + "issue": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2" + }, "comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments" + }, "review_comments": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments" + }, "review_comment": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}" + }, "commits": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits" + }, "statuses": { "href": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1" + } }, "author_association": "OWNER" }, "repository": { "id": 118, + "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", + "avatar_url": "https://octocoders.github.io/avatars/u/4?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:37:10Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + pull_request_review_thread +

    +
    +
    + Activity related to a comment thread on a pull request being + marked as resolved or unresolved. The type of activity is + specified in the action property of the payload + object. +
    +

    Availability for pull_request_review_thread

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Pull requests permission +
      • +
    +

    + Webhook payload object for pull_request_review_thread +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "pages": [
-    {
-      "page_name": "Home",
-      "title": "Home",
-      "summary": null,
-      "action": "edited",
-      "sha": "4bbb6df16cb5ce1818602bf634e94ebdac7ae385",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home"
-    }
-  ],
-  "repository": {
-    "id": 122,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-10-04T18:29:19Z",
-    "updated_at": "2018-10-04T18:29:21Z",
-    "pushed_at": "2018-10-04T18:29:59Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "rachmari",
-    "id": 3,
-    "node_id": "MDQ6VXNlcjM=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/3?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/rachmari",
-    "html_url": "https://octocoders.github.io/rachmari",
-    "followers_url": "https://octocoders.github.io/api/v3/users/rachmari/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/rachmari/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/rachmari/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/rachmari/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/rachmari/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + resolved - A comment thread on a + pull request was marked as resolved. +
      • +
    • + unresolved - A previously resolved + comment thread on a pull request was marked as + unresolved. +
      • +
    +
    +
    +
    +
    +
    +
    +
    pull_request object
    +
    +
    + The + pull request + the thread pertains to. +
    +
    +
    +
    +
    +
    +
    thread object
    +
    +
    The thread that was affected.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "action": "resolved", "pull_request": { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118", "id": + 873298238, "node_id": "PR_kwDOEL39TM40DXk-", "html_url": + "https://github.com/octo-org/octo-repo/pull/118", "diff_url": + "https://github.com/octo-org/octo-repo/pull/118.diff", + "patch_url": + "https://github.com/octo-org/octo-repo/pull/118.patch", + "issue_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/118", + "number": 118, "state": "open", "locked": false, "title": "Create + issue-comment", "user": { "login": "octocat", "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true }, "body": "Issue comment test", + "created_at": "2022-03-07T16:14:34Z", "updated_at": + "2022-03-21T09:21:38Z", "closed_at": null, "merged_at": null, + "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1", + "assignee": null, "assignees": [], "requested_reviewers": [], + "requested_teams": [], "labels": [], "milestone": null, "draft": + false, "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits", + "review_comments_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments", + "review_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "head": { "label": "octo-org:issue-comment", "ref": + "issue-comment", "sha": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "user": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "repo": { "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" } }, "base": { "label": + "octo-org:master", "ref": "master", "sha": + "fcaaddec44575a657bf81b049208b2ce139da3ca", "user": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "repo": { "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" } }, "_links": { "self": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118" }, + "html": { "href": "https://github.com/octo-org/octo-repo/pull/118" + }, "issue": { "href": + "https://api.github.com/repos/octo-org/octo-repo/issues/118" }, + "comments": { "href": + "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments" + }, "review_comments": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments" + }, "review_comment": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}" + }, "commits": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits" + }, "statuses": { "href": + "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf" + } }, "author_association": "CONTRIBUTOR", "auto_merge": null, + "active_lock_reason": null }, "thread": { "node_id": + "PRRT_kwDOEL39TM4w7XDQ", "comments": [ { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280", + "pull_request_review_id": 901921390, "id": 820867280, "node_id": + "PRRC_kwDOEL39TM4w7XDQ", "diff_hunk": "@@ -0,0 +1 @@\n+issue + comment", "path": "issue-comment", "position": 1, + "original_position": 1, "commit_id": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "original_commit_id": + "14ae1f988d344e6b4f97f6153fb0287dcda335bf", "user": { "login": + "jide2020", "id": 64502150, "node_id": "MDQ6VXNlcjY0NTAyMTUw", + "avatar_url": + "https://avatars.githubusercontent.com/u/64502150?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/jide2020", + "html_url": "https://github.com/jide2020", "followers_url": + "https://api.github.com/users/jide2020/followers", + "following_url": + "https://api.github.com/users/jide2020/following{/other_user}", + "gists_url": + "https://api.github.com/users/jide2020/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/jide2020/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/jide2020/subscriptions", + "organizations_url": "https://api.github.com/users/jide2020/orgs", + "repos_url": "https://api.github.com/users/jide2020/repos", + "events_url": + "https://api.github.com/users/jide2020/events{/privacy}", + "received_events_url": + "https://api.github.com/users/jide2020/received_events", "type": + "User", "site_admin": false }, "body": "sup", "created_at": + "2022-03-07T16:16:48Z", "updated_at": "2022-03-07T16:16:58Z", + "html_url": + "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280", + "pull_request_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118", + "author_association": "COLLABORATOR", "_links": { "self": { + "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280" + }, "html": { "href": + "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280" + }, "pull_request": { "href": + "https://api.github.com/repos/octo-org/octo-repo/pulls/118" } }, + "reactions": { "url": + "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions", + "total_count": 0, "+1": 0, "-1": 0, "laugh": 0, "hooray": 0, + "confused": 0, "heart": 0, "rocket": 0, "eyes": 0 }, "start_line": + null, "original_start_line": null, "start_side": null, "line": 1, + "original_line": 1, "side": "RIGHT" } ] }, "repository": { "id": + 280886604, "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", "name": + "octo-repo", "full_name": "octo-org/octo-repo", "private": true, + "owner": { "login": "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "Change + description", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", "updated_at": + "2022-03-11T11:56:22Z", "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 646, "stargazers_count": 1, "watchers_count": 1, "language": + "Ruby", "has_issues": true, "has_projects": true, "has_downloads": + true, "has_wiki": true, "has_pages": false, "forks_count": 0, + "mirror_url": null, "archived": false, "disabled": false, + "open_issues_count": 60, "license": null, "allow_forking": false, + "is_template": false, "topics": [ "hey", "topic" ], "visibility": + "private", "forks": 0, "open_issues": 60, "watchers": 1, + "default_branch": "master" }, "organization": { "login": + "octo-org", "id": 67584941, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/67584941?v=4", + "description": "" }, "sender": { "login": "octocat", "id": + 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true } } +
    + -

    - - installation -

    -

    - Activity related to a GitHub App installation. The type of activity is - specified in the action property of the payload object. For - more information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • created - Someone installs a GitHub App.
      • -
    • deleted - Someone uninstalls a GitHub App
      • -
    • - suspend - Someone suspends a GitHub App - installation. -
      • -
    • - unsuspend - Someone unsuspends a GitHub App - installation. -
      • -
    • - new_permissions_accepted - Someone accepts new - permissions for a GitHub App installation. When a GitHub App - owner requests new permissions, the person who installed the - GitHub App must accept the new permissions request. -
      • -
    -
    repositoriesarray - An array of repository objects that the installation can access. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-      "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-      "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-      "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-      "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-      "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "checks": "write",
-      "contents": "write",
-      "deployments": "write",
-      "issues": "write",
-      "pages": "write",
-      "pull_requests": "write",
-      "repository_hooks": "write",
-      "repository_projects": "write",
-      "statuses": "write",
-      "repository_pre_receive_hooks": "write",
-      "metadata": "read",
-      "vulnerability_alerts": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": "2019-05-15T19:37:38.000Z",
-    "updated_at": "2019-05-15T19:37:38.000Z",
-    "single_file_name": null
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-    "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-    "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-    "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-    "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + push +

    +
    +
    +

    + Note: You will not receive a webhook for this + event when you push more than three tags at once. +

    + One or more commits are pushed to a repository branch or tag. +
    +

    Availability for push

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for push

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    ref string
    +
    +
    + The full + git ref + that was pushed. Example: + refs/heads/main or + refs/tags/v3.14.1. +
    +
    +
    +
    +
    +
    +
    before string
    +
    +
    + The SHA of the most recent commit on + ref before the push. +
    +
    +
    +
    +
    +
    +
    after string
    +
    +
    + The SHA of the most recent commit on + ref after the push. +
    +
    +
    +
    +
    +
    +
    created boolean
    +
    +
    + Whether this push created the ref. +
    +
    +
    +
    +
    +
    +
    deleted boolean
    +
    +
    + Whether this push deleted the ref. +
    +
    +
    +
    +
    +
    +
    forced boolean
    +
    +
    + Whether this push was a force push of the + ref. +
    +
    +
    +
    +
    +
    +
    head_commit object
    +
    +
    + For pushes where after is or points to + a commit object, an expanded representation of that + commit. For pushes where after refers + to an annotated tag object, an expanded + representation of the commit pointed to by the + annotated tag. +
    +
    +
    +
    +
    +
    +
    compare string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    commits array
    +
    +
    + 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.) +
    +
    +
    +
    +
    +
    +
    + commits[][id] string +
    +
    +
    The SHA of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][timestamp] string +
    +
    +
    The ISO 8601 timestamp of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][message] string +
    +
    +
    The commit message.
    +
    +
    +
    +
    +
    +
    + commits[][author] object +
    +
    +
    The git author of the commit.
    +
    +
    +
    +
    +
    +
    + commits[][author][name] + string +
    +
    +
    The git author's name.
    +
    +
    +
    +
    +
    +
    + commits[][author][email] + string +
    +
    +
    The git author's email address.
    +
    +
    +
    +
    +
    +
    commits[][url] url
    +
    +
    URL that points to the commit API resource.
    +
    +
    +
    +
    +
    +
    + commits[][distinct] boolean +
    +
    +
    + Whether this commit is distinct from any that have + been pushed before. +
    +
    +
    +
    +
    +
    +
    + commits[][added] array +
    +
    +
    + An array of files added in the commit. For extremely + large commits where GitHub Enterprise Server is + unable to calculate this list in a timely manner, + this may be empty even if files were added. +
    +
    +
    +
    +
    +
    +
    + commits[][modified] array +
    +
    +
    + An array of files modified by the commit. For + extremely large commits where GitHub Enterprise + Server is unable to calculate this list in a timely + manner, this may be empty even if files were + modified. +
    +
    +
    +
    +
    +
    +
    + commits[][removed] array +
    +
    +
    + An array of files removed in the commit. For + extremely large commits where GitHub Enterprise + Server is unable to calculate this list in a timely + manner, this may be empty even if files were + removed. +
    +
    +
    +
    +
    +
    +
    pusher object
    +
    +
    The user who pushed the commits.
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "ref": "refs/tags/simple-tag", "before": + "0000000000000000000000000000000000000000", "after": + "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "created": true, + "deleted": false, "forced": false, "base_ref": null, "compare": + "https://octocoders.github.io/Codertocat/Hello-World/compare/simple-tag", + "commits": [], "head_commit": { "id": + "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "tree_id": + "4b825dc642cb6eb9a060e54bf8d69288fbee4904", "distinct": true, + "message": "Adding a .gitignore file", "timestamp": + "2019-05-15T15:20:41Z", "url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "author": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "username": "Codertocat" }, + "committer": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "username": "Codertocat" }, "added": [ + ".gitignore" ], "removed": [], "modified": [] }, "repository": { + "id": 118, "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=", "name": + "Hello-World", "full_name": "Codertocat/Hello-World", "private": + false, "owner": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "login": "Codertocat", "id": 4, + "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": 1557949027, "updated_at": "2019-05-15T19:38:15Z", + "pushed_at": 1557949103, "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master", "stargazers": 0, "master_branch": + "master" }, "pusher": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    -

    - - installation_repositories -

    -

    - Activity related to repositories being added to a GitHub App - installation. The type of activity is specified in the - action property of the payload object. For more - information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be either added or - removed. -
    repository_selectionstring - The choice of repositories the installation is on. Can be either - selected or all. -
    repositories_addedarray - An array of repository objects, which were added to the - installation. -
    repositories_removedarray - An array of repository objects, which were removed from the - installation. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "https://octocoders.github.io/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "https://octocoders.github.io/api/v3/installation/repositories",
-    "html_url": "https://octocoders.github.io/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "repository_pre_receive_hooks": "write",
-      "statuses": "write",
-      "repository_projects": "write",
-      "repository_hooks": "write",
-      "pull_requests": "write",
-      "pages": "write",
-      "issues": "write",
-      "deployments": "write",
-      "contents": "write",
-      "checks": "write",
-      "vulnerability_alerts": "read",
-      "metadata": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": 1557949058,
-    "updated_at": 1557949058,
-    "single_file_name": null
-  },
-  "repository_selection": "selected",
-  "repositories_added": [
-    {
-      "id": 119,
-      "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=",
-      "name": "Space",
-      "full_name": "Codertocat/Space",
-      "private": false
-    }
-  ],
-  "repositories_removed": [],
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - issue_comment -

    -

    - Activity related to an issue or pull request comment. The type of - activity is specified in the action property of the payload - object. For more information, see the "issue comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    issueobject - The - issue - the comment belongs to. -
    commentobject - The - comment - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "id": 2,
-    "node_id": "MDEyOklzc3VlQ29tbWVudDI=",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:37:55Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "author_association": "OWNER",
-    "body": "You are totally right! I'll get this fixed right away."
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - issues -

    -

    - Activity related to an issue. The type of activity is specified in the - action property of the payload object. For more - information, see the "issues" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of opened, - edited, deleted, pinned, - unpinned, closed, reopened, - assigned, unassigned, - labeled, unlabeled, locked, - unlocked, transferred, - milestoned, or demilestoned. -
    issueobject - The - issue - itself. -
    changesobject - The changes to the issue if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    assigneeobject - The optional user who was assigned or unassigned from the issue. -
    labelobject - The optional label that was added or removed from the issue. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example when someone edits an issue -

    -
    - 
    {
-  "action": "edited",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:54Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "changes": {},
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - label -

    -

    - Activity related to a label. The type of activity is specified in the - action property of the payload object. For more - information, see the "labels" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be created, - edited, or deleted. -
    labelobjectThe label that was added.
    changesobject - The changes to the label if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[color][from]string - The previous version of the color if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "label": {
-    "id": 965,
-    "node_id": "MDU6TGFiZWw5NjU=",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix",
-    "name": ":bug: Bugfix",
-    "color": "cceeaa",
-    "default": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - member -

    -

    - Activity related to repository collaborators. The type of activity is - specified in the action property of the payload object. For - more information, see the "collaborators" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - added - A user accepts an invitation to a - repository. -
      • -
    • - removed - A user is removed as a collaborator in - a repository. -
      • -
    • - edited - A user's collaborator permissions have - changed. -
      • -
    -
    memberobject - The - user - that was added. -
    changesobject - The changes to the collaborator permissions if the action was - edited. -
    changes[old_permission][from]string - The previous permissions of the collaborator if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "member": {
-    "login": "Hacktocat",
-    "id": 5,
-    "node_id": "MDQ6VXNlcjU=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-    "html_url": "https://octocoders.github.io/Hacktocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - membership -

    -

    - Activity related to team membership. The type of activity is specified - in the action property of the payload object. For more - information, see the "team members" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be added or - removed. -
    scopestring - The scope of the membership. Currently, can only be - team. -
    memberobject - The - user - that was added or removed. -
    teamobject - The - team - for the membership. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "removed",
-  "scope": "team",
-  "member": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  }
-}
-
    -
    -

    - - meta -

    -

    - The webhook this event is configured on was deleted. This event will - only listen for changes to the particular hook the event is installed - on. Therefore, it must be selected for each hook that you'd like to - receive meta events for. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be deleted.
    hook_idintegerThe id of the modified webhook.
    hookobject - The modified webhook. This will contain different keys based on - the type of webhook it is: repository, organization, business, - app, or GitHub Marketplace. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "hook_id": 101047067,
-  "hook": {
-    "type": "Repository",
-    "id": 101047067,
-    "name": "web",
-    "active": true,
-    "events": [
-      "meta"
-    ],
-    "config": {
-      "content_type": "json",
-      "insecure_ssl": "0",
-      "url": "http://example.com/hook"
-    },
-    "updated_at": "2019-04-10T03:57:12Z",
-    "created_at": "2019-04-10T03:57:12Z"
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - milestone -

    -

    - Activity related to milestones. The type of activity is specified in the - action property of the payload object. For more - information, see the "milestones" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - closed, opened (a closed milestone is - re-opened), edited, or deleted. -
    milestoneobjectThe milestone itself.
    changesobject - The changes to the milestone if the action was - edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[due_on][from]string - The previous version of the due date if the action was - edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "milestone": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-    "id": 2,
-    "node_id": "MDk6TWlsZXN0b25lMg==",
-    "number": 1,
-    "title": "v1.0",
-    "description": "Add new space flight simulator",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "open_issues": 0,
-    "closed_issues": 0,
-    "state": "open",
-    "created_at": "2019-05-15T19:37:52Z",
-    "updated_at": "2019-05-15T19:37:52Z",
-    "due_on": "2019-05-23T00:00:00Z",
-    "closed_at": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - organization -

    -

    - Activity related to an organization and its members. The type of - activity is specified in the action property of the payload - object. For more information, see the "organizations" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: - created, deleted, renamed, - member_added, member_removed, or - member_invited. -
    invitationobject - The invitation for the user or email if the action is - member_invited. -
    membershipobject - The membership between the user and the organization. Not present - when the action is member_invited. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "member_added",
-  "membership": {
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat",
-    "state": "active",
-    "role": "member",
-    "organization_url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "user": {
-      "login": "Hacktocat",
-      "id": 5,
-      "node_id": "MDQ6VXNlcjU=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-      "html_url": "https://octocoders.github.io/Hacktocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-      "type": "User",
-      "site_admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - package -

    -

    - Activity related to GitHub Packages. The type of activity is specified - in the action property of the payload object. For more - information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be published or - updated. -
    packageobjectInformation about the package.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "package": {
-    "id": 10696,
-    "name": "hello-world-npm",
-    "namespace": "Codertocat/hello-world-npm",
-    "description": null,
-    "ecosystem": "docker",
-    "package_type": "npm",
-    "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696",
-    "created_at": "2019-05-09T23:28:29Z",
-    "updated_at": "2019-05-09T23:28:29Z",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "package_version": {
-      "id": 24147,
-      "version": "1.0.0",
-      "summary": "A simple npm package to demonstrate GitHub Packages",
-      "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498",
-      "description": "",
-      "body": "# hello-world-npm\n\nThis is a simple npm package that demonstrates the [Github Packages](https://github.com/features/package).\n\n## Installation \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n",
-      "body_html": "<h1>hello-world-npm</h1>\n<p>This is a simple npm package that demonstrates the <a href=\"https://github.com/features/package\">Github Package Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ npm install</code></p>\n<h2>Usage</h2>\n<pre><code>const myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>",
-      "release": {
-        "url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286",
-        "html_url": "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0",
-        "id": 17264286,
-        "tag_name": "1.0.0",
-        "target_commitish": "master",
-        "name": "1.0.0",
-        "draft": false,
-        "author": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "prerelease": false,
-        "created_at": "2019-05-09T23:24:40Z",
-        "published_at": "2019-05-09T23:26:59Z"
-      },
-      "manifest": "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A simple npm package to demonstrate GitHub Package Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo \\\"Error: no test specified\\\" \\u0026\\u0026 exit 1\"},\"version\":\"1.0.0\"}",
-      "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0",
-      "tag_name": "1.0.0",
-      "target_commitish": "master",
-      "target_oid": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b",
-      "draft": false,
-      "prerelease": false,
-      "created_at": "2019-05-09T23:28:29Z",
-      "updated_at": "2019-05-09T23:28:30Z",
-      "metadata": [],
-      "docker_metadata": [],
-      "package_files": [
-        {
-          "download_url": "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream",
-          "id": 92167,
-          "name": "hello-world-npm-1.0.0-npm.tgz",
-          "sha256": "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8",
-          "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb",
-          "md5": "56ebbd5a5a03367f62d0c732bafd3c66",
-          "content_type": "application/octet-stream",
-          "state": "uploaded",
-          "size": 654,
-          "created_at": "2019-05-09T23:28:30Z",
-          "updated_at": "2019-05-09T23:28:30Z"
-        }
-      ],
-      "author": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "source_url": "ghcr.io/Codertocat/hello-world-npm/image-1:v1",
-      "installation_command": "npm install @Codertocat/@1.0.0"
-    },
-    "registry": {
-      "about_url": "https://help.github.com/about-github-packages",
-      "name": "GitHub npm registry",
-      "type": "npm",
-      "url": "https://npm.pkg.github.com/@Codertocat",
-      "vendor": "GitHub Inc"
-    }
-  },
-  "repository": {
-    "id": 185882436,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=",
-    "name": "hello-world-npm",
-    "full_name": "Codertocat/hello-world-npm",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/hello-world-npm",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world-npm",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments",
-    "created_at": "2019-05-09T22:53:26Z",
-    "updated_at": "2019-05-09T23:24:42Z",
-    "pushed_at": "2019-05-09T23:27:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world-npm.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world-npm.git",
-    "clone_url": "https://github.com/Codertocat/hello-world-npm.git",
-    "svn_url": "https://github.com/Codertocat/hello-world-npm",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - page_build -

    -

    - Represents an attempted build of a GitHub Pages site, whether successful - or not. A push to a GitHub Pages enabled branch (gh-pages - for project pages, the default branch for user and organization pages) - triggers this event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    idintegerThe unique identifier of the page build.
    buildobject - The - List GitHub Pages builds - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 7,
-  "build": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7",
-    "status": "built",
-    "error": {
-      "message": null
-    },
-    "pusher": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "commit": "3648135c2986115284ae152d90459473b15fd19c",
-    "duration": 6917,
-    "created_at": "2019-05-15T19:38:15Z",
-    "updated_at": "2019-05-15T19:38:22Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - ping -

    -

    - When you create a new webhook, we'll send you a simple - ping event to let you know you've set up the webhook - correctly. This event isn't stored so it isn't retrievable via the - Events API - endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    zenstringRandom string of GitHub zen.
    hook_idintegerThe ID of the webhook that triggered the ping.
    hookobject - The - webhook configuration. -
    hook[app_id]integer - When you register a new GitHub App, GitHub Enterprise Server sends - a ping event to the webhook URL you specified - during registration. The event contains the app_id, - which is required for - authenticating - an app. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "zen": "Non-blocking is better than blocking.",
-  "hook_id": 30,
-  "hook": {
-    "type": "Repository",
-    "id": 30,
-    "name": "web",
-    "active": true,
-    "events": [
-      "*"
-    ],
-    "config": {
-      "content_type": "json",
-      "url": "https://smee.io/YEbF2t8kjvPAn7Ck",
-      "insecure_ssl": "0"
-    },
-    "updated_at": "2019-05-15T19:38:17Z",
-    "created_at": "2019-05-15T19:38:17Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30",
-    "test_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test",
-    "ping_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings",
-    "last_response": {
-      "code": null,
-      "status": "unused",
-      "message": null
-    }
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - project -

    -

    - Activity related to project boards. The type of activity is specified in - the action property of the payload object. For more - information, see the "projects" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project. Can be one of - created, edited, closed, - reopened, or deleted. -
    changesobject - The changes to the project if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    projectobject - The - project - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project": {
-    "owner_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "url": "https://octocoders.github.io/api/v3/projects/6",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/projects/1",
-    "columns_url": "https://octocoders.github.io/api/v3/projects/6/columns",
-    "id": 6,
-    "node_id": "MDc6UHJvamVjdDY=",
-    "name": "Space 2.0",
-    "body": "Project tasks for a trip to Space",
-    "number": 1,
-    "state": "open",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:38:27Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - project_card -

    -

    - Activity related to cards in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project cards" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed on the project card. Can be - created, edited, moved, - converted, or deleted. -
    changesobject - The changes to the project card if the action was - edited or converted. -
    changes[note][from]string - The previous version of the note if the action was - edited or converted. -
    after_idinteger - The id of the card that this card now follows if the action was - "moved". Will be null if it is the first card in a - column. -
    project_cardobject - The - project card - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_card": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/cards/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "column_url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "column_id": 8,
-    "id": 8,
-    "node_id": "MDExOlByb2plY3RDYXJkOA==",
-    "note": "Work that can be completed in one hour or less.",
-    "archived": false,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - project_column -

    -

    - Activity related to columns in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project columns" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the project column. Can be one of - created, edited, moved or - deleted. -
    changesobject - The changes to the project column if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    after_idinteger - The id of the column that this column now follows if the action - was "moved". Will be null if it is the first column - in a project. -
    project_columnobject - The - project column - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_column": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "cards_url": "https://octocoders.github.io/api/v3/projects/columns/8/cards",
-    "id": 8,
-    "node_id": "MDEzOlByb2plY3RDb2x1bW44",
-    "name": "Small bugfixes",
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - public -

    -

    - When a private repository is made public. Without a doubt: the best - GitHub Enterprise Server event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request -

    -

    - Activity related to pull requests. The type of activity is specified in - the action property of the payload object. For more - information, see the "pull requests" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • assigned
      • -
    • auto_merge_disabled
      • -
    • auto_merge_enabled
      • -
    • - closed: If the action is closed and - the merged key is false, the pull - request was closed with unmerged commits. If the action is - closed and the merged key is - true, the pull request was merged. -
      • -
    • converted_to_draft
      • -
    • edited
      • -
    • labeled
      • -
    • locked
      • -
    • opened
      • -
    • ready_for_review
      • -
    • reopened
      • -
    • review_request_removed
      • -
    • review_requested
      • -
    • - synchronize: Triggered when a pull request's head - branch is updated. For example, when the head branch is - updated from the base branch, when new commits are pushed to - the head branch, or when the base branch is changed. -
      • -
    • unassigned
      • -
    • unlabeled
      • -
    • unlocked
      • -
    -
    numberintegerThe pull request number.
    changesobject - The changes to the comment if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -

    - Deliveries for review_requested and - review_request_removed events will have an additional field - called requested_reviewer. -

    -
    - 
    {
-  "action": "opened",
-  "number": 2,
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:02Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": null,
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER",
-    "draft": false,
-    "merged": false,
-    "mergeable": null,
-    "rebaseable": null,
-    "mergeable_state": "unknown",
-    "merged_by": null,
-    "comments": 0,
-    "review_comments": 0,
-    "maintainer_can_modify": false,
-    "commits": 1,
-    "additions": 1,
-    "deletions": 1,
-    "changed_files": 1
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review -

    -

    - Activity related to pull request reviews. The type of activity is - specified in the action property of the payload object. For - more information, see the "pull request reviews" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - submitted - A pull request review is submitted - into a non-pending state. -
      • -
    • - edited - The body of a review has been edited. -
      • -
    • dismissed - A review has been dismissed.
      • -
    -
    pull_requestobject - The - pull request - the review pertains to. -
    reviewobjectThe review that was affected.
    changes[body][from]string - The previous version of the body if the action was - edited. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "submitted",
-  "review": {
-    "id": 2,
-    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": null,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "submitted_at": "2019-05-15T19:38:08Z",
-    "state": "commented",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review_comment -

    -

    - Activity related to pull request review comments in the pull request's - unified diff. The type of activity is specified in the - action property of the payload object. For more - information, see the "pull request review comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request - the comment belongs to. -
    commentobject - The - comment - itself. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2",
-    "pull_request_review_id": 2,
-    "id": 2,
-    "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=",
-    "diff_hunk": "@@ -1 +1 @@\n-# Hello-World",
-    "path": "README.md",
-    "position": 1,
-    "original_position": 1,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "original_commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "Maybe you should use more emoji on this line.",
-    "created_at": "2019-05-15T19:38:07Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - pull_request_review_thread -

    -

    - Activity related to a comment thread on a pull request being marked as - resolved or unresolved. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - resolved - A comment thread on a pull request was - marked as resolved. -
      • -
    • - unresolved - A previously resolved comment thread - on a pull request was marked as unresolved. -
      • -
    -
    pull_requestobject - The - pull request - the thread pertains to. -
    threadobjectThe thread that was affected.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "resolved",
-  "pull_request": {
-    "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-    "id": 873298238,
-    "node_id": "PR_kwDOEL39TM40DXk-",
-    "html_url": "https://github.com/octo-org/octo-repo/pull/118",
-    "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff",
-    "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch",
-    "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118",
-    "number": 118,
-    "state": "open",
-    "locked": false,
-    "title": "Create issue-comment",
-    "user": {
-      "login": "octocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "body": "Issue comment test",
-    "created_at": "2022-03-07T16:14:34Z",
-    "updated_at": "2022-03-21T09:21:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "draft": false,
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits",
-    "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments",
-    "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-    "head": {
-      "label": "octo-org:issue-comment",
-      "ref": "issue-comment",
-      "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "octo-org:master",
-      "ref": "master",
-      "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-      },
-      "html": {
-        "href": "https://github.com/octo-org/octo-repo/pull/118"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf"
-      }
-    },
-    "author_association": "CONTRIBUTOR",
-    "auto_merge": null,
-    "active_lock_reason": null
-  },
-  "thread": {
-    "node_id": "PRRT_kwDOEL39TM4w7XDQ",
-    "comments": [
-      {
-        "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280",
-        "pull_request_review_id": 901921390,
-        "id": 820867280,
-        "node_id": "PRRC_kwDOEL39TM4w7XDQ",
-        "diff_hunk": "@@ -0,0 +1 @@\n+issue comment",
-        "path": "issue-comment",
-        "position": 1,
-        "original_position": 1,
-        "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "user": {
-          "login": "jide2020",
-          "id": 64502150,
-          "node_id": "MDQ6VXNlcjY0NTAyMTUw",
-          "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/jide2020",
-          "html_url": "https://github.com/jide2020",
-          "followers_url": "https://api.github.com/users/jide2020/followers",
-          "following_url": "https://api.github.com/users/jide2020/following{/other_user}",
-          "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions",
-          "organizations_url": "https://api.github.com/users/jide2020/orgs",
-          "repos_url": "https://api.github.com/users/jide2020/repos",
-          "events_url": "https://api.github.com/users/jide2020/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/jide2020/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "body": "sup",
-        "created_at": "2022-03-07T16:16:48Z",
-        "updated_at": "2022-03-07T16:16:58Z",
-        "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280",
-        "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-        "author_association": "COLLABORATOR",
-        "_links": {
-          "self": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280"
-          },
-          "html": {
-            "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280"
-          },
-          "pull_request": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-          }
-        },
-        "reactions": {
-          "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions",
-          "total_count": 0,
-          "+1": 0,
-          "-1": 0,
-          "laugh": 0,
-          "hooray": 0,
-          "confused": 0,
-          "heart": 0,
-          "rocket": 0,
-          "eyes": 0
-        },
-        "start_line": null,
-        "original_start_line": null,
-        "start_side": null,
-        "line": 1,
-        "original_line": 1,
-        "side": "RIGHT"
-      }
-    ]
-  },
-  "repository": {
-    "id": 280886604,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 67584941,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-      "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "Change description",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2020-07-19T14:48:35Z",
-    "updated_at": "2022-03-11T11:56:22Z",
-    "pushed_at": "2022-04-01T09:37:36Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 646,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 60,
-    "license": null,
-    "allow_forking": false,
-    "is_template": false,
-    "topics": [
-      "hey",
-      "topic"
-    ],
-    "visibility": "private",
-    "forks": 0,
-    "open_issues": 60,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 67584941,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - push -

    -

    One or more commits are pushed to a repository branch or tag.

    -
    -

    - Note: You will not receive a webhook for this event - when you push more than three tags at once. -

    -
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The full - git ref - that was pushed. Example: refs/heads/main or - refs/tags/v3.14.1. -
    beforestring - The SHA of the most recent commit on ref before the - push. -
    afterstring - The SHA of the most recent commit on ref after the - push. -
    createdbooleanWhether this push created the ref.
    deletedbooleanWhether this push deleted the ref.
    forcedbooleanWhether this push was a force push of the ref.
    head_commitobject - For pushes where after is or points to a commit - object, an expanded representation of that commit. For pushes - where after refers to an annotated tag object, an - expanded representation of the commit pointed to by the annotated - tag. -
    comparestring - 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. -
    commitsarray - 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.) -
    commits[][id]stringThe SHA of the commit.
    commits[][timestamp]stringThe ISO 8601 timestamp of the commit.
    commits[][message]stringThe commit message.
    commits[][author]objectThe git author of the commit.
    commits[][author][name]stringThe git author's name.
    commits[][author][email]stringThe git author's email address.
    commits[][url]urlURL that points to the commit API resource.
    commits[][distinct]boolean - Whether this commit is distinct from any that have been pushed - before. -
    commits[][added]array - An array of files added in the commit. For extremely large commits - where GitHub Enterprise Server is unable to calculate this list in - a timely manner, this may be empty even if files were added. -
    commits[][modified]array - An array of files modified by the commit. For extremely large - commits where GitHub Enterprise Server is unable to calculate this - list in a timely manner, this may be empty even if files were - modified. -
    commits[][removed]array - An array of files removed in the commit. For extremely large - commits where GitHub Enterprise Server is unable to calculate this - list in a timely manner, this may be empty even if files were - removed. -
    pusherobjectThe user who pushed the commits.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "refs/tags/simple-tag",
-  "before": "0000000000000000000000000000000000000000",
-  "after": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-  "created": true,
-  "deleted": false,
-  "forced": false,
-  "base_ref": null,
-  "compare": "https://octocoders.github.io/Codertocat/Hello-World/compare/simple-tag",
-  "commits": [],
-  "head_commit": {
-    "id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "tree_id": "4b825dc642cb6eb9a060e54bf8d69288fbee4904",
-    "distinct": true,
-    "message": "Adding a .gitignore file",
-    "timestamp": "2019-05-15T15:20:41Z",
-    "url": "https://octocoders.github.io/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246",
-    "author": {
-      "name": "Codertocat",
-      "email": "Codertocat@Octocoders.io",
-      "username": "Codertocat"
-    },
-    "committer": {
-      "name": "Codertocat",
-      "email": "Codertocat@Octocoders.io",
-      "username": "Codertocat"
-    },
-    "added": [
-      ".gitignore"
-    ],
-    "removed": [],
-    "modified": []
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "name": "Codertocat",
-      "email": "Codertocat@Octocoders.io",
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": 1557949027,
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": 1557949103,
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master",
-    "stargazers": 0,
-    "master_branch": "master"
-  },
-  "pusher": {
-    "name": "Codertocat",
-    "email": "Codertocat@Octocoders.io"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - release -

    -

    - Activity related to a release. The type of activity is specified in the - action property of the payload object. For more - information, see the "releases" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - published: a release, pre-release, or draft of a - release is published -
      • -
    • - unpublished: a release or pre-release is deleted -
      • -
    • - created: a draft is saved, or a release or - pre-release is published without previously being saved as a - draft -
      • -
    • - edited: a release, pre-release, or draft release - is edited -
      • -
    • - deleted: a release, pre-release, or draft release - is deleted -
      • -
    • prereleased: a pre-release is created
      • -
    • - released: a release is published, or a - pre-release is changed to a release -
      • -
    -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    releaseobject - The - release - object. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "release": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2",
-    "assets_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets",
-    "upload_url": "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1",
-    "id": 2,
-    "node_id": "MDc6UmVsZWFzZTI=",
-    "tag_name": "0.0.1",
-    "target_commitish": "master",
-    "name": null,
-    "draft": false,
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "prerelease": false,
-    "created_at": "2019-05-15T19:37:08Z",
-    "published_at": "2019-05-15T19:38:20Z",
-    "assets": [],
-    "tarball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1",
-    "zipball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1",
-    "body": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - repository_dispatch -

    -

    - This event occurs when a GitHub App sends a POST request to - the "Create a repository dispatch event" endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "on-demand-test",
-  "branch": "master",
-  "client_payload": {
-    "unit": false,
-    "integration": true
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2018-10-10T15:58:51Z",
-    "pushed_at": "2018-10-10T15:58:47Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 59,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 23,
-    "license": null,
-    "forks": 1,
-    "open_issues": 23,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 375706,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2"
-  }
-}
-
    -
    -

    - - repository -

    -

    - Activity related to a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "repositories" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of: -
      -
    • created - A repository is created.
      • -
    • deleted - A repository is deleted.
      • -
    • archived - A repository is archived.
      • -
    • unarchived - A repository is unarchived.
      • -
    • - anonymous_access_enabled - A repository is - enabled for anonymous Git access, anonymous_access_disabled - A repository is - disabled for anonymous Git access -
      • -
    • - edited - A repository's information is edited. -
      • -
    • renamed - A repository is renamed.
      • -
    • transferred - A repository is transferred.
      • -
    • publicized - A repository is made public.
      • -
    • privatized - A repository is made private.
      • -
    -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "publicized",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - secret_scanning_alert -

    -

    - Activity related to secret scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see the "secret scanning API." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be either - created, resolved, or - reopened. -
    alertobjectThe secret scanning alert involved in the event.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is resolved or - reopened, the sender object will be the - user that triggered the event. The sender object is - empty for all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 191,
-    "secret_type": "adafruit_io_key",
-    "resolution": null,
-    "resolved_by": null,
-    "resolved_at": null
-  },
-  "repository": {
-    "id": 257423561,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 30846345,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2020-04-20T22:59:11Z",
-    "updated_at": "2020-11-24T01:37:33Z",
-    "pushed_at": "2020-11-24T01:37:31Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 1156,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": false,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 3,
-    "license": null,
-    "forks": 0,
-    "open_issues": 3,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Codertocat",
-    "id": 30846345,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-    "url": "https://api.github.com/orgs/Codertocat",
-    "repos_url": "https://api.github.com/orgs/Codertocat/repos",
-    "events_url": "https://api.github.com/orgs/Codertocat/events",
-    "hooks_url": "https://api.github.com/orgs/Codertocat/hooks",
-    "issues_url": "https://api.github.com/orgs/Codertocat/issues",
-    "members_url": "https://api.github.com/orgs/Codertocat/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Codertocat/public_members{/member}",
-    "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-    "description": "Demos and testing of GitHub security products"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 10136561,
-    "node_id": "MDQ6VXNlcjEwMTM2NTYx",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/10136561?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - secret_scanning_alert_location -

    -

    - Activity related to secret scanning alert locations in a repository. The - type of activity is specified in the action property of the payload - object. For more information, see the "secret scanning" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - created. -
    locationobjectThe location involved in the event.
    alertobject - The - secret scanning alert - involved in the event. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "location": {
-    "type": "commit",
-    "details": {
-      "path": "/example/secrets.txt",
-      "start_line": 1,
-      "end_line": 1,
-      "start_column": 1,
-      "end_column": 64,
-      "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
-      "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b",
-      "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b",
-      "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
-    }
-  },
-  "alert": {
-    "number": 191,
-    "secret_type": "adafruit_io_key",
-    "resolution": null,
-    "created_at": "2022-04-01T11:01:10Z",
-    "updated_at": "2022-04-01T12:04:28Z",
-    "resolved_by": null,
-    "resolved_at": null
-  },
-  "repository": {
-    "id": 257423561,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 30846345,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2020-04-20T22:59:11Z",
-    "updated_at": "2020-11-24T01:37:33Z",
-    "pushed_at": "2020-11-24T01:37:31Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 1156,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": false,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 3,
-    "license": null,
-    "forks": 0,
-    "open_issues": 3,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Codertocat",
-    "id": 30846345,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1",
-    "url": "https://api.github.com/orgs/Codertocat",
-    "repos_url": "https://api.github.com/orgs/Codertocat/repos",
-    "events_url": "https://api.github.com/orgs/Codertocat/events",
-    "hooks_url": "https://api.github.com/orgs/Codertocat/hooks",
-    "issues_url": "https://api.github.com/orgs/Codertocat/issues",
-    "members_url": "https://api.github.com/orgs/Codertocat/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/Codertocat/public_members{/member}",
-    "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4",
-    "description": "Demos and testing of GitHub security products"
-  }
-}
-
    -
    -

    - - security_advisory -

    -

    - Activity related to a security advisory that has been reviewed by - GitHub. A GitHub-reviewed security advisory provides information about - security-related vulnerabilities in software on GitHub. -

    -

    - The security advisory dataset also powers the GitHub Dependabot alerts. - For more information, see "About Dependabot alerts." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. The action can be one of - published, updated, - performed, or withdrawn for all new - events. -
    security_advisoryobject - The details of the security advisory, including summary, - description, and severity. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "security_advisory": {
-    "ghsa_id": "GHSA-rf4j-j272-fj86",
-    "summary": "Moderate severity vulnerability that affects django",
-    "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
-    "severity": "moderate",
-    "identifiers": [
-      {
-        "value": "GHSA-rf4j-j272-fj86",
-        "type": "GHSA"
-      },
-      {
-        "value": "CVE-2018-6188",
-        "type": "CVE"
-      }
-    ],
-    "references": [
-      {
-        "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
-      }
-    ],
-    "published_at": "2018-10-03T21:13:54Z",
-    "updated_at": "2018-10-03T21:13:54Z",
-    "withdrawn_at": null,
-    "vulnerabilities": [
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
-        "first_patched_version": {
-          "identifier": "2.0.2"
-        }
-      },
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
-        "first_patched_version": {
-          "identifier": "1.11.10"
-        }
-      }
-    ]
-  }
-}
-
    -
    -

    - - star -

    -

    - Activity related to a repository being starred. The type of activity is - specified in the action property of the payload object. For - more information, see the "starring" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created or - deleted. -
    starred_atstring - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "starred_at": "2019-05-15T15:20:40Z",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:40Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - status -

    -

    - When the status of a Git commit changes. For more information, see the - "statuses" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + +
    KeyTypeDescription
    idintegerThe unique identifier of the status.
    shastringThe Commit SHA.
    statestring - The new state. Can be pending, success, - failure, or error. -
    descriptionstring - The optional human-readable description added to the status. -
    target_urlstringThe optional link added to the status.
    branchesarray - 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. -
    repositoryobject - The - repository +
    +

    + release +

    +
    +
    + Activity related to a release. The type of activity is specified + in the action property of the payload object. For + more information, see the "releases" REST API. +
    +

    Availability for release

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for release

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of: +
      +
    • + published: a release, pre-release, + or draft of a release is published +
      • +
    • + unpublished: a release or + pre-release is deleted +
      • +
    • + created: a draft is saved, or a + release or pre-release is published without + previously being saved as a draft +
      • +
    • + edited: a release, pre-release, or + draft release is edited +
      • +
    • + deleted: a release, pre-release, or + draft release is deleted +
      • +
    • + prereleased: a pre-release is + created +
      • +
    • + released: a release is published, + or a pre-release is changed to a release +
      • +
    +
    +
    +
    +
    +
    +
    +
    + changes[body][from] string +
    +
    +
    + The previous version of the body if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    release object
    +
    +
    + The + release + object. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "release": { "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2", + "assets_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets", + "upload_url": + "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1", + "id": 2, "node_id": "MDc6UmVsZWFzZTI=", "tag_name": "0.0.1", + "target_commitish": "master", "name": null, "draft": false, + "author": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "prerelease": false, + "created_at": "2019-05-15T19:37:08Z", "published_at": + "2019-05-15T19:38:20Z", "assets": [], "tarball_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1", + "zipball_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1", + "body": null }, "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    +
    + +
    +
    +

    + repository_dispatch +

    +
    +
    + This event occurs when a GitHub App sends a + POST request to the "Create a repository dispatch event" endpoint. +
    +

    Availability for repository_dispatch

    +
      +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for repository_dispatch

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 2,
-  "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-  "name": "Codertocat/Hello-World",
-  "target_url": null,
-  "context": "default",
-  "description": null,
-  "state": "success",
-  "commit": {
-    "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "node_id": "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=",
-    "commit": {
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@Octocoders.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "committer": {
-        "name": "GitHub Enterprise",
-        "email": "noreply@octocoders.github.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "message": "Initial commit",
-      "tree": {
-        "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4"
-      },
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-      "comment_count": 1,
-      "verification": {
-        "verified": false,
-        "reason": "unsigned",
-        "signature": null,
-        "payload": null
-      }
-    },
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments",
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "committer": null,
-    "parents": []
-  },
-  "branches": [
-    {
-      "name": "master",
-      "commit": {
-        "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a"
-      },
-      "protected": false
-    },
-    {
-      "name": "changes",
-      "commit": {
-        "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1"
-      },
-      "protected": false
-    },
-    {
-      "name": "gh-pages",
-      "commit": {
-        "sha": "3648135c2986115284ae152d90459473b15fd19c",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c"
-      },
-      "protected": false
-    }
-  ],
-  "created_at": "2019-05-15T19:38:21+00:00",
-  "updated_at": "2019-05-15T19:38:21+00:00",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    +
    + +

    Webhook payload example

    +
    + { "action": "on-demand-test", "branch": "master", + "client_payload": { "unit": false, "integration": true }, + "repository": { "id": 17273051, "node_id": + "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", "name": "octo-repo", + "full_name": "octo-org/octo-repo", "private": true, "owner": { + "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": + "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/octo-repo", "description": "My first + repo on GitHub!", "fork": false, "url": + "https://api.github.com/repos/octo-org/octo-repo", "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2014-02-28T02:42:51Z", "updated_at": + "2018-10-10T15:58:51Z", "pushed_at": "2018-10-10T15:58:47Z", + "git_url": "git://github.com/octo-org/octo-repo.git", "ssh_url": + "git@github.com:octo-org/octo-repo.git", "clone_url": + "https://github.com/octo-org/octo-repo.git", "svn_url": + "https://github.com/octo-org/octo-repo", "homepage": "", "size": + 59, "stargazers_count": 0, "watchers_count": 0, "language": + "JavaScript", "has_issues": true, "has_projects": true, + "has_downloads": true, "has_wiki": true, "has_pages": false, + "forks_count": 1, "mirror_url": null, "archived": false, + "open_issues_count": 23, "license": null, "forks": 1, + "open_issues": 23, "watchers": 0, "default_branch": "master" }, + "organization": { "login": "octo-org", "id": 6811672, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "url": + "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars3.githubusercontent.com/u/6811672?v=4", + "description": "Working better together!" }, "sender": { "login": + "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "installation": { "id": 375706, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2" } + } +
    + -

    - - team -

    -

    - Activity related to an organization's team. The type of activity is - specified in the action property of the payload object. For - more information, see the "teams" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - deleted, edited, - added_to_repository, or - removed_from_repository. -
    teamobjectThe team itself.
    changesobject - The changes to the team if the action was edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[privacy][from]string - The previous version of the team's privacy if the action was - edited. -
    changes[repository][permissions][from][admin]boolean - The previous version of the team member's - admin permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][pull]boolean - The previous version of the team member's - pull permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][push]boolean - The previous version of the team member's - push permission on a repository, if the action was - edited. -
    repositoryobject - The repository that was added or removed from to the team's - purview if the action was added_to_repository, - removed_from_repository, or edited. For - edited actions, repository also contains - the team's new permission levels for the repository. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + repository +

    +
    +
    + Activity related to a repository. The type of activity is + specified in the action property of the payload + object. For more information, see the "repositories" REST API. +
    +

    Availability for repository

    +
      +
    • + Repository webhooks receive all event types except + deleted +
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Metadata permission receive + all event types except deleted +
      • +
    +

    Webhook payload object for repository

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added_to_repository",
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "permissions": {
-      "pull": true,
-      "push": false,
-      "admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. This can be one of: +
      +
    • + created - A repository is created. +
      • +
    • + deleted - A repository is deleted. +
      • +
    • + archived - A repository is + archived. +
      • +
    • + unarchived - A repository is + unarchived. +
      • +
    • + anonymous_access_enabled - A + repository is + enabled for anonymous Git access, anonymous_access_disabled - A + repository is + disabled for anonymous Git access +
      • +
    • + edited - A repository's information + is edited. +
      • +
    • + renamed - A repository is renamed. +
      • +
    • + transferred - A repository is + transferred. +
      • +
    • + publicized - A repository is made + public. +
      • +
    • + privatized - A repository is made + private. +
      • +
    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "publicized", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:25Z", "pushed_at": "2019-05-15T19:38:23Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - team_add -

    -

    - When a - repository is added to a team. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    teamobject - The - team - that was modified. Note: Older events may not - include this in the payload. -
    repositoryobject - The - repository +
    +

    + repository_vulnerability_alert +

    +
    +
    +

    + This event occurs when there is activity relating to a security + vulnerability alert in a repository. +

    +

    + Note: This event is deprecated. Use the + dependabot_alert event instead. +

    +
    +

    + Availability for repository_vulnerability_alert +

    +
      +
    • repository
      • +
    • organization
      • +
    +

    + Webhook payload object for + repository_vulnerability_alert +

    +
    +
    + +
    +
    +

    A repository vulnerability alert was created.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: create +

    +
    +
    +
    +
    +
    +
    + alert Required +
    +
    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +

    An enterprise on GitHub.

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. This property is + included when the event is configured for and sent + to a GitHub App. +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +

    A GitHub organization.

    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +

    A repository on GitHub.

    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +

    A GitHub user.

    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + secret_scanning_alert +

    +
    +
    + Activity related to secret scanning alerts in a repository. The + type of activity is specified in the action property of the + payload object. For more information, see the "secret scanning API." +
    +

    Availability for secret_scanning_alert

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Secret scanning alerts permission +
      • +
    +

    + Webhook payload object for secret_scanning_alert +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. This can be either + created, resolved, or + reopened. +
    +
    +
    +
    +
    +
    +
    alert object
    +
    +
    + The secret scanning alert involved in the event. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    + If the action is + resolved or reopened, the + sender object will be the user that + triggered the event. The sender object + is empty for all other actions. +
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "reopened", "alert": { "number": 191, "secret_type": + "adafruit_io_key", "resolution": null, "resolved_by": null, + "resolved_at": null }, "repository": { "id": 257423561, "node_id": + "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": true, "owner": { + "login": "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2020-04-20T22:59:11Z", "updated_at": + "2020-11-24T01:37:33Z", "pushed_at": "2020-11-24T01:37:31Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 1156, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": + false, "has_projects": false, "has_downloads": true, "has_wiki": + false, "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 3, + "license": null, "forks": 0, "open_issues": 3, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "url": + "https://api.github.com/orgs/Codertocat", "repos_url": + "https://api.github.com/orgs/Codertocat/repos", "events_url": + "https://api.github.com/orgs/Codertocat/events", "hooks_url": + "https://api.github.com/orgs/Codertocat/hooks", "issues_url": + "https://api.github.com/orgs/Codertocat/issues", "members_url": + "https://api.github.com/orgs/Codertocat/members{/member}", + "public_members_url": + "https://api.github.com/orgs/Codertocat/public_members{/member}", + "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "description": "Demos and testing of GitHub security products" }, + "sender": { "login": "Codertocat", "id": 10136561, "node_id": + "MDQ6VXNlcjEwMTM2NTYx", "avatar_url": + "https://avatars1.githubusercontent.com/u/10136561?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": true } } +
    + -

    - - user -

    -

    When a user is created or deleted.

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "user": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "action": "created",
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + secret_scanning_alert_location +

    +
    +
    + Activity related to secret scanning alert locations in a + repository. The type of activity is specified in the action + property of the payload object. For more information, see the "secret scanning" REST API. +
    +

    + Availability for secret_scanning_alert_location +

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with + Secret scanning alerts permission +
      • +
    +

    + Webhook payload object for + secret_scanning_alert_location +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Currently, can only + be created. +
    +
    +
    +
    +
    +
    +
    location object
    +
    +
    The location involved in the event.
    +
    +
    +
    +
    +
    +
    alert object
    +
    +
    + The + secret scanning alert + involved in the event. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "location": { "type": "commit", "details": + { "path": "/example/secrets.txt", "start_line": 1, "end_line": 1, + "start_column": 1, "end_column": 64, "blob_sha": + "af5626b4a114abcb82d63db7c8082c3c4756e51b", "blob_url": + "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": + "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } }, "alert": { "number": 191, "secret_type": "adafruit_io_key", + "resolution": null, "created_at": "2022-04-01T11:01:10Z", + "updated_at": "2022-04-01T12:04:28Z", "resolved_by": null, + "resolved_at": null }, "repository": { "id": 257423561, "node_id": + "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": true, "owner": { + "login": "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2020-04-20T22:59:11Z", "updated_at": + "2020-11-24T01:37:33Z", "pushed_at": "2020-11-24T01:37:31Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 1156, "stargazers_count": 0, + "watchers_count": 0, "language": "JavaScript", "has_issues": + false, "has_projects": false, "has_downloads": true, "has_wiki": + false, "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 3, + "license": null, "forks": 0, "open_issues": 3, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Codertocat", "id": 30846345, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", "url": + "https://api.github.com/orgs/Codertocat", "repos_url": + "https://api.github.com/orgs/Codertocat/repos", "events_url": + "https://api.github.com/orgs/Codertocat/events", "hooks_url": + "https://api.github.com/orgs/Codertocat/hooks", "issues_url": + "https://api.github.com/orgs/Codertocat/issues", "members_url": + "https://api.github.com/orgs/Codertocat/members{/member}", + "public_members_url": + "https://api.github.com/orgs/Codertocat/public_members{/member}", + "avatar_url": + "https://avatars0.githubusercontent.com/u/30846345?v=4", + "description": "Demos and testing of GitHub security products" } + } +
    +
    -

    - - watch -

    -

    - When someone stars a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "starring" REST API. -

    -

    - The event’s actor is the - user who - starred a repository, and the event’s repository is the - repository - that was starred. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - started. -
    repositoryobject - The - repository +
    +

    + security_advisory +

    +
    +
    + Activity related to a security advisory that has been reviewed by + GitHub. A GitHub-reviewed security advisory provides information + about security-related vulnerabilities in software on GitHub.The + security advisory dataset also powers the GitHub Dependabot + alerts. For more information, see "About Dependabot alerts." +
    +

    Availability for security_advisory

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for security_advisory

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. The action can be one + of published, updated, + performed, or + withdrawn for all new events. +
    +
    +
    +
    +
    +
    +
    + security_advisory object +
    +
    +
    + The details of the security advisory, including + summary, description, and severity. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "published", "security_advisory": { "ghsa_id": + "GHSA-rf4j-j272-fj86", "summary": "Moderate severity vulnerability + that affects django", "description": + "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before + 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain + potentially sensitive information by leveraging data exposure from + the confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive.", "severity": "moderate", + "identifiers": [ { "value": "GHSA-rf4j-j272-fj86", "type": "GHSA" + }, { "value": "CVE-2018-6188", "type": "CVE" } ], "references": [ + { "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" } ], + "published_at": "2018-10-03T21:13:54Z", "updated_at": + "2018-10-03T21:13:54Z", "withdrawn_at": null, "vulnerabilities": [ + { "package": { "ecosystem": "pip", "name": "django" }, "severity": + "moderate", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { "identifier": "2.0.2" } }, { "package": + { "ecosystem": "pip", "name": "django" }, "severity": "moderate", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { "identifier": "1.11.10" } } ] } } +
    +
    + +
    +
    +

    + star +

    +
    +
    + Activity related to a repository being starred. The type of + activity is specified in the action property of the + payload object. For more information, see the "starring" REST API. +
    +

    Availability for star

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    +

    Webhook payload object for star

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be created or + deleted. +
    +
    +
    +
    +
    +
    +
    starred_at string
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "created", "starred_at": "2019-05-15T15:20:40Z", + "repository": { "id": 186853002, "node_id": + "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": "Hello-World", + "full_name": "Codertocat/Hello-World", "private": false, "owner": + { "login": "Codertocat", "id": 21031067, "node_id": + "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false }, "html_url": + "https://github.com/Codertocat/Hello-World", "description": null, + "fork": false, "url": + "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", "updated_at": + "2019-05-15T15:20:40Z", "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 1, + "watchers_count": 1, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 1, + "default_branch": "master" }, "sender": { "login": "Codertocat", + "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", "url": + "https://api.github.com/users/Codertocat", "html_url": + "https://github.com/Codertocat", "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": + "https://api.github.com/users/Codertocat/orgs", "repos_url": + "https://api.github.com/users/Codertocat/repos", "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", "type": + "User", "site_admin": false } } +
    +
    +
    +
    +
    +

    + status +

    +
    +
    + When the status of a Git commit changes. For more information, see + the "statuses" REST API. +
    +

    Availability for status

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • + GitHub Apps with Commit statuses permission +
      • +
    +

    Webhook payload object for status

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "started",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    id integer
    +
    +
    The unique identifier of the status.
    +
    +
    +
    +
    +
    +
    sha string
    +
    +
    The Commit SHA.
    +
    +
    +
    +
    +
    +
    state string
    +
    +
    + The new state. Can be pending, + success, failure, or + error. +
    +
    +
    +
    +
    +
    +
    description string
    +
    +
    + The optional human-readable description added to the + status. +
    +
    +
    +
    +
    +
    +
    target_url string
    +
    +
    The optional link added to the status.
    +
    +
    +
    +
    +
    +
    branches array
    +
    +
    + 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. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    + +

    Webhook payload example

    +
    + { "id": 2, "sha": "4544205a385319fd846d5df4ed2e3b8173529d78", + "name": "Codertocat/Hello-World", "target_url": null, "context": + "default", "description": null, "state": "success", "commit": { + "sha": "4544205a385319fd846d5df4ed2e3b8173529d78", "node_id": + "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=", + "commit": { "author": { "name": "Codertocat", "email": + "Codertocat@Octocoders.io", "date": "2019-05-15T19:37:08Z" }, + "committer": { "name": "GitHub Enterprise", "email": + "noreply@octocoders.github.io", "date": "2019-05-15T19:37:08Z" }, + "message": "Initial commit", "tree": { "sha": + "1b13fc88733f95cc8cb16170f6990ef30d78acf4", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4" + }, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78", + "comment_count": 1, "verification": { "verified": false, "reason": + "unsigned", "signature": null, "payload": null } }, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78", + "html_url": + "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments", + "author": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "committer": null, + "parents": [] }, "branches": [ { "name": "master", "commit": { + "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a" + }, "protected": false }, { "name": "changes", "commit": { "sha": + "14977a7b5485400124827221a04bfb474bcd72d1", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1" + }, "protected": false }, { "name": "gh-pages", "commit": { "sha": + "3648135c2986115284ae152d90459473b15fd19c", "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c" + }, "protected": false } ], "created_at": + "2019-05-15T19:38:21+00:00", "updated_at": + "2019-05-15T19:38:21+00:00", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:15Z", "pushed_at": "2019-05-15T19:38:19Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 1, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 1, "open_issues": 2, "watchers": 0, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - workflow_dispatch -

    -

    - This event occurs when someone triggers a workflow run on GitHub or - sends a POST request to the "Create a workflow dispatch event" endpoint. For more information, see "Events that trigger workflows." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    inputsobject - Inputs to the workflow. Each key represents the name of the input - while its value represents the value of that input. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + team +

    +
    +
    + Activity related to an organization's team. The type of activity + is specified in the action property of the payload + object. For more information, see the "teams" REST API. +
    +

    Availability for team

    +
      +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for team

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    refstringThe branch or tag from which the workflow was run.
    repositoryobject - The +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + created, deleted, + edited, + added_to_repository, or + removed_from_repository. +
    +
    +
    +
    +
    +
    +
    team object
    +
    +
    The team itself.
    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    + The changes to the team if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[description][from] + string +
    +
    +
    + The previous version of the description if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[name][from] string +
    +
    +
    + The previous version of the name if the action was + edited. +
    +
    +
    +
    +
    +
    +
    + changes[privacy][from] + string +
    +
    +
    + The previous version of the team's privacy if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][admin] + boolean +
    +
    +
    + The previous version of the team member's + admin permission on a repository, if + the action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][pull] + boolean +
    +
    +
    + The previous version of the team member's + pull permission on a repository, if the + action was edited. +
    +
    +
    +
    +
    +
    +
    + changes[repository][permissions][from][push] + boolean +
    +
    +
    + The previous version of the team member's + push permission on a repository, if the + action was edited. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The repository that was added or removed from to the + team's purview if the action was + added_to_repository, + removed_from_repository, or + edited. For + edited actions, + repository also contains the team's new + permission levels for the repository. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "added_to_repository", "team": { "name": "github", + "id": 3, "node_id": "MDQ6VGVhbTM=", "slug": "github", + "description": "Open-source team", "privacy": "secret", "url": + "https://octocoders.github.io/api/v3/teams/3", "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master", "permissions": { "pull": true, "push": + false, "admin": false } }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false } } +
    +
    + +
    +
    +

    + team_add +

    +
    +
    + When a repositoryrepository is added to a team. +
    +

    Availability for team_add

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Members permission
      • +
    +

    Webhook payload object for team_add

    +
    +
    + - where the event occurred. - - - - - - - - - - - - - -
    senderobjectThe user that triggered the event.
    workflowstring - Relative path to the workflow file which contains the workflow. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "inputs": {
-    "name": "Mona the Octocat"
-  },
-  "organization": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": null,
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "id": 79927191,
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "login": "octo-org",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "url": "https://api.github.com/orgs/octo-org"
-  },
-  "ref": "refs/heads/main",
-  "repository": {
-    "allow_forking": true,
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "created_at": "2021-08-16T21:34:28Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "fork": false,
-    "forks": 1,
-    "forks_count": 1,
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "full_name": "octo-org/octo-repo",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "id": 6811672,
-    "is_template": false,
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "mirror_url": null,
-    "name": "octo-repo",
-    "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "open_issues": 97,
-    "open_issues_count": 97,
-    "owner": {
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/octo-org",
-      "id": 79927191,
-      "login": "octo-org",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/octo-org"
-    },
-    "private": false,
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "pushed_at": "2022-01-07T21:57:21Z",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "size": 144,
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "topics": [],
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "updated_at": "2022-01-07T21:57:24Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "visibility": "public",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars.githubusercontent.com/u/25328854?v=4",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/octocat",
-    "id": 25328754,
-    "login": "octocat",
-    "node_id": "MDQ6VXNlcjI1MzI4ODU0",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/octocat"
-  },
-  "workflow": ".github/workflows/hello-world-workflow.yml"
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    team object
    +
    +
    + The + team + that was modified. Note: Older + events may not include this in the payload. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "team": { "name": "github", "id": 3, "node_id": "MDQ6VGVhbTM=", + "slug": "github", "description": "Open-source team", "privacy": + "secret", "url": "https://octocoders.github.io/api/v3/teams/3", + "html_url": + "https://octocoders.github.io/orgs/Octocoders/teams/github", + "members_url": + "https://octocoders.github.io/api/v3/teams/3/members{/member}", + "repositories_url": + "https://octocoders.github.io/api/v3/teams/3/repos", "permission": + "pull" }, "repository": { "id": 120, "node_id": + "MDEwOlJlcG9zaXRvcnkxMjA=", "name": "Hello-World", "full_name": + "Octocoders/Hello-World", "private": false, "owner": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "gravatar_id": "", "url": + "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "html_url": + "https://octocoders.github.io/Octocoders/Hello-World", + "description": null, "fork": true, "url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T19:38:10Z", "updated_at": + "2019-05-15T19:38:14Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Octocoders/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Octocoders/Hello-World.git", + "svn_url": "https://octocoders.github.io/Octocoders/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 0, + "watchers_count": 0, "language": "Ruby", "has_issues": false, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "master" }, "organization": { "login": + "Octocoders", "id": 6, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", + "url": "https://octocoders.github.io/api/v3/orgs/Octocoders", + "repos_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/events", + "hooks_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks", + "issues_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/issues", + "members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}", + "public_members_url": + "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://octocoders.github.io/avatars/u/6?", + "description": "" }, "enterprise": { "id": 1, "slug": "github", + "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Octocoders", "id": 6, "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY=", "avatar_url": + "https://octocoders.github.io/avatars/u/6?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Octocoders", + "html_url": "https://octocoders.github.io/Octocoders", + "followers_url": + "https://octocoders.github.io/api/v3/users/Octocoders/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Octocoders/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Octocoders/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Octocoders/received_events", + "type": "Organization", "site_admin": false } } +
    + -

    - - workflow_job -

    -

    - A GitHub Actions workflow job has been queued, is in progress, or has - been completed on a repository. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • queued - A new job was created.
      • -
    • - in_progress - The job has started processing on - the runner. -
      • -
    • - completed - The status of the job is - completed. -
      • -
    -
    workflow_jobobject - The workflow job. Many workflow_job keys, such as - head_sha, conclusion, and - started_at are the same as those in a - check_run object. -
    workflow_job[status]string - The current status of the job. Can be queued, - in_progress, or completed. -
    workflow_job[labels]array - Custom labels for the job. Specified by the - "runs-on" attribute +
    +

    + user +

    +
    +
    + When a user is created or deleted. +
    +

    Availability for user

    +
      +
    • + GitHub Enterprise webhooks. For more information, "Global webhooks." +
      • +
    +

    Webhook payload object for user

    +
    +
    + - in the workflow YAML. - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
    workflow_job[runner_id]integer - The ID of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_name]string - The name of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_id]integer - The ID of the runner group that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_name]string - The name of the runner group that is running this job. This will - be null as long as - workflow_job[status] is queued. -
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    +
    +
    +

    Webhook payload example

    +
    + { "user": { "login": "Snowtocat", "id": 16, "node_id": + "MDQ6VXNlcjE2", "avatar_url": + "https://octocoders.github.io/avatars/u/16?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Snowtocat", + "html_url": "https://octocoders.github.io/Snowtocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/received_events", + "type": "User", "site_admin": false }, "action": "created", + "enterprise": { "id": 1, "slug": "github", "name": "GitHub", + "node_id": "MDg6QnVzaW5lc3Mx", "avatar_url": + "https://octocoders.github.io/avatars/b/1?", "description": null, + "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Snowtocat", "id": 16, "node_id": + "MDQ6VXNlcjE2", "avatar_url": + "https://octocoders.github.io/avatars/u/16?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Snowtocat", + "html_url": "https://octocoders.github.io/Snowtocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Snowtocat/received_events", + "type": "User", "site_admin": false } } +
    +
    + +
    +
    +

    + watch +

    +
    +
    + When someone stars a repository. The type of activity is specified + in the action property of the payload object. For + more information, see the "starring" REST API.The event’s actor is the + user + who starred a repository, and the event’s repository is the + repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization +

    Availability for watch

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • GitHub Apps with Metadata permission
      • +
    +

    Webhook payload object for watch

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "in_progress",
-  "workflow_job": {
-    "id": 2832853555,
-    "run_id": 940463255,
-    "run_url": "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255",
-    "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55",
-    "head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055",
-    "url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555",
-    "html_url": "https://github.com/octo-org/example-workflow/runs/2832853555",
-    "status": "in_progress",
-    "conclusion": null,
-    "started_at": "2021-06-15T19:22:27Z",
-    "completed_at": null,
-    "name": "Test workflow",
-    "steps": [
-      {
-        "name": "Set up job",
-        "status": "in_progress",
-        "conclusion": null,
-        "number": 1,
-        "started_at": "2021-06-15T19:22:27.000Z",
-        "completed_at": null
-      }
-    ],
-    "check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555",
-    "labels": [
-      "gpu",
-      "db-app",
-      "dc-03"
-    ],
-    "runner_id": 1,
-    "runner_name": "my runner",
-    "runner_group_id": 2,
-    "runner_group_name": "my runner group"
-  },
-  "repository": {
-    "id": 376034443,
-    "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55",
-    "name": "example-workflow",
-    "full_name": "octo-org/example-workflow",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 33435655,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-      "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/example-workflow",
-    "description": "Test workflow",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/example-workflow",
-    "forks_url": "https://api.github.com/repos/octo-org/example-workflow/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/example-workflow/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/example-workflow/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/example-workflow/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/example-workflow/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/example-workflow/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/example-workflow/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/example-workflow/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/example-workflow/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/example-workflow/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/example-workflow/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/example-workflow/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/example-workflow/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/example-workflow/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/example-workflow/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/example-workflow/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/example-workflow/deployments",
-    "created_at": "2021-06-11T13:29:13Z",
-    "updated_at": "2021-06-11T13:33:01Z",
-    "pushed_at": "2021-06-11T13:32:58Z",
-    "git_url": "git://github.com/octo-org/example-workflow.git",
-    "ssh_url": "git@github.com:octo-org/example-workflow.git",
-    "clone_url": "https://github.com/octo-org/example-workflow.git",
-    "svn_url": "https://github.com/octo-org/example-workflow",
-    "homepage": null,
-    "size": 1,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 33435655,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "description": "octo-org"
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 319655,
-    "node_id": "MDQ6VXNlcjMxOTY1NQ55",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Currently, can only + be started. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    + The GitHub App installation. Webhook payloads + contain the installation property when + the event is configured for and sent to a GitHub + App. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "started", "repository": { "id": 118, "node_id": + "MDEwOlJlcG9zaXRvcnkxMTg=", "name": "Hello-World", "full_name": + "Codertocat/Hello-World", "private": false, "owner": { "login": + "Codertocat", "id": 4, "node_id": "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "html_url": + "https://octocoders.github.io/Codertocat/Hello-World", + "description": null, "fork": false, "url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World", + "forks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks", + "keys_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams", + "hooks_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks", + "issue_events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events", + "assignees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags", + "blobs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages", + "stargazers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers", + "contributors_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors", + "subscribers_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription", + "commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges", + "archive_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads", + "issues_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": + "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T19:37:07Z", "updated_at": + "2019-05-15T19:38:09Z", "pushed_at": "2019-05-15T19:38:03Z", + "git_url": + "git://octocoders.github.io/Codertocat/Hello-World.git", + "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git", + "clone_url": + "https://octocoders.github.io/Codertocat/Hello-World.git", + "svn_url": "https://octocoders.github.io/Codertocat/Hello-World", + "homepage": null, "size": 0, "stargazers_count": 1, + "watchers_count": 1, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": true, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 2, + "license": null, "forks": 0, "open_issues": 2, "watchers": 1, + "default_branch": "master" }, "enterprise": { "id": 1, "slug": + "github", "name": "GitHub", "node_id": "MDg6QnVzaW5lc3Mx", + "avatar_url": "https://octocoders.github.io/avatars/b/1?", + "description": null, "website_url": null, "html_url": + "https://octocoders.github.io/businesses/github", "created_at": + "2019-05-14T19:31:12Z", "updated_at": "2019-05-14T19:31:12Z" }, + "sender": { "login": "Codertocat", "id": 4, "node_id": + "MDQ6VXNlcjQ=", "avatar_url": + "https://octocoders.github.io/avatars/u/4?", "gravatar_id": "", + "url": "https://octocoders.github.io/api/v3/users/Codertocat", + "html_url": "https://octocoders.github.io/Codertocat", + "followers_url": + "https://octocoders.github.io/api/v3/users/Codertocat/followers", + "following_url": + "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}", + "gists_url": + "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}", + "starred_url": + "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions", + "organizations_url": + "https://octocoders.github.io/api/v3/users/Codertocat/orgs", + "repos_url": + "https://octocoders.github.io/api/v3/users/Codertocat/repos", + "events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}", + "received_events_url": + "https://octocoders.github.io/api/v3/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { "id": 5, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } +
    + -

    - - workflow_run -

    -

    - When a GitHub Actions workflow run is requested or completed. For more - information, see "Events that trigger workflows." -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of - requested or completed. -
    workflow_runobject - The workflow run. Includes information such as - artifacts_url, check_suite_id, - conclusion, head_branch, and - head_sha. -
    workflowobjectThe workflow that generated the workflow run.
    organizationobject - Webhook payloads contain the - organization +
    +

    + workflow_dispatch +

    +
    +
    + This event occurs when someone triggers a workflow run on GitHub + or sends a POST request to the "Create a workflow dispatch event" endpoint. For more information, see "Events that trigger workflows." +
    +

    Availability for workflow_dispatch

    +
      +
    • GitHub Apps with Contents permission
      • +
    +

    Webhook payload object for workflow_dispatch

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    inputs object
    +
    +
    + Inputs to the workflow. Each key represents the name + of the input while its value represents the value of + that input. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    ref string
    +
    +
    + The branch or tag from which the workflow was run. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    workflow string
    +
    +
    + Relative path to the workflow file which contains + the workflow. +
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "inputs": { "name": "Mona the Octocat" }, "organization": { + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "description": null, "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "id": 79927191, + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "login": "octo-org", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "repos_url": "https://api.github.com/orgs/octo-org/repos", "url": + "https://api.github.com/orgs/octo-org" }, "ref": + "refs/heads/main", "repository": { "allow_forking": true, + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "archived": false, "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "created_at": "2021-08-16T21:34:28Z", "default_branch": "main", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "disabled": false, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks": 1, "forks_count": 1, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_url": "git://github.com/octo-org/octo-repo.git", + "has_downloads": true, "has_issues": true, "has_pages": false, + "has_projects": true, "has_wiki": true, "homepage": null, + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 6811672, "is_template": false, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "language": null, "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "license": null, "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "mirror_url": null, "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "open_issues": 97, "open_issues_count": 97, "owner": { + "avatar_url": + "https://avatars.githubusercontent.com/u/6811672?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": false, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "pushed_at": "2022-01-07T21:57:21Z", "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "size": 144, "ssh_url": "git@github.com:octo-org/octo-repo.git", + "stargazers_count": 0, "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "svn_url": "https://github.com/octo-org/octo-repo", "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", "topics": + [], "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "updated_at": "2022-01-07T21:57:24Z", "url": + "https://api.github.com/repos/octo-org/octo-repo", "visibility": + "public", "watchers": 0, "watchers_count": 0 }, "sender": { + "avatar_url": + "https://avatars.githubusercontent.com/u/25328854?v=4", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octocat", "id": + 25328754, "login": "octocat", "node_id": "MDQ6VXNlcjI1MzI4ODU0", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": + "https://api.github.com/users/octocat/received_events", + "repos_url": "https://api.github.com/users/octocat/repos", + "site_admin": true, "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", "type": + "User", "url": "https://api.github.com/users/octocat" }, + "workflow": ".github/workflows/hello-world-workflow.yml" } +
    +
    + +
    +
    +

    + workflow_job +

    +
    +
    + A GitHub Actions workflow job has been queued, is in progress, or + has been completed on a repository. The type of activity is + specified in the action property of the payload + object. +
    +

    Availability for workflow_job

    +
      +
    • Repository webhooks
      • +
    • Organization webhooks
      • +
    • Enterprise webhooks
      • +
    +

    Webhook payload object for workflow_job

    +
    +
    + - where the event occurred. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "organization": {
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "description": "",
-    "events_url": "https://api.github.com/orgs/Octocoders/events",
-    "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
-    "id": 33435682,
-    "issues_url": "https://api.github.com/orgs/Octocoders/issues",
-    "login": "Codertocat",
-    "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
-    "repos_url": "https://api.github.com/orgs/Octocoders/repos",
-    "url": "https://api.github.com/orgs/Codertocat"
-  },
-  "repository": {
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "archived": false,
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "created_at": "2020-07-29T09:57:16Z",
-    "default_branch": "main",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "description": null,
-    "disabled": false,
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "fork": false,
-    "forks": 0,
-    "forks_count": 0,
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "full_name": "Codertocat/Hello-World",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "has_downloads": true,
-    "has_issues": true,
-    "has_pages": false,
-    "has_projects": true,
-    "has_wiki": true,
-    "homepage": null,
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "id": 283462325,
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "language": null,
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "license": null,
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "mirror_url": null,
-    "name": "Hello-World",
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "open_issues": 0,
-    "open_issues_count": 0,
-    "owner": {
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "gravatar_id": "",
-      "html_url": "https://github.com/Codertocat",
-      "id": 33435682,
-      "login": "Codertocat",
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "site_admin": false,
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "type": "Organization",
-      "url": "https://api.github.com/users/Codertocat"
-    },
-    "private": true,
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "pushed_at": "2020-07-29T10:06:16Z",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "size": 0,
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "stargazers_count": 0,
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "updated_at": "2020-07-29T10:06:18Z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "watchers": 0,
-    "watchers_count": 0
-  },
-  "sender": {
-    "avatar_url": "https://avatars3.githubusercontent.com/u/54248166?v=4",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "gravatar_id": "",
-    "html_url": "https://github.com/Codertocat",
-    "id": 54248166,
-    "login": "Codertocat",
-    "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "site_admin": true,
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "type": "User",
-    "url": "https://api.github.com/users/Codertocat"
-  },
-  "workflow": {
-    "badge_url": "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg",
-    "created_at": "2021-12-15T20:11:38.000Z",
-    "html_url": "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml",
-    "id": 16340987,
-    "name": "Manually triggered workflow",
-    "node_id": "W_kwDOF6lyTM4A-Vf7",
-    "path": ".github/workflows/syntax.yml",
-    "state": "active",
-    "updated_at": "2021-12-16T18:40:41.000Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  },
-  "workflow_run": {
-    "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts",
-    "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel",
-    "check_suite_id": 4683454167,
-    "check_suite_node_id": "CS_kwDOF6lyTM8AAAABFyfW1w",
-    "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167",
-    "conclusion": null,
-    "created_at": "2021-12-16T19:37:22Z",
-    "event": "workflow_dispatch",
-    "head_branch": "main",
-    "head_commit": {
-      "author": {
-        "email": "octocat@github.com",
-        "name": "Mona Lisa"
-      },
-      "committer": {
-        "email": "noreply@github.com",
-        "name": "GitHub"
-      },
-      "id": "5779607b49aab1200488439f02372c57b4f75444",
-      "message": "Update milestone-created.yml",
-      "timestamp": "2021-12-16T19:37:14Z",
-      "tree_id": "8181cee091cf9627ac07c3cc4b94c015a1d56706"
-    },
-    "head_repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "head_sha": "5779607b49aab1200488439f02372c57b4f75444",
-    "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1589141559",
-    "id": 1589141559,
-    "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs",
-    "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs",
-    "name": "Manually triggered workflow",
-    "node_id": "WFR_kwLOF6lyTM5euGA3",
-    "previous_attempt_url": null,
-    "pull_requests": [],
-    "repository": {
-      "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-      "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-      "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-      "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-      "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-      "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-      "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-      "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-      "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-      "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-      "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-      "description": null,
-      "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-      "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-      "fork": false,
-      "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-      "full_name": "octo-org/octo-repo",
-      "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-      "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-      "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-      "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-      "html_url": "https://github.com/octo-org/octo-repo",
-      "id": 396980812,
-      "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-      "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-      "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-      "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-      "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-      "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-      "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-      "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-      "name": "octo-repo",
-      "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
-      "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-      "owner": {
-        "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "gravatar_id": "",
-        "html_url": "https://github.com/octo-org",
-        "id": 79927191,
-        "login": "octo-org",
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "site_admin": false,
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "type": "Organization",
-        "url": "https://api.github.com/users/octo-org"
-      },
-      "private": true,
-      "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-      "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-      "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-      "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-      "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-      "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-      "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-      "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-      "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-      "url": "https://api.github.com/repos/octo-org/octo-repo"
-    },
-    "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun",
-    "run_attempt": 1,
-    "run_number": 36,
-    "run_started_at": "2021-12-16T19:37:22Z",
-    "status": "queued",
-    "updated_at": "2021-12-16T19:37:22Z",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559",
-    "workflow_id": 16340987,
-    "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987"
-  }
-}
-
    +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action performed. Can be one of: +
      +
    • + queued - A new job was created. +
      • +
    • + in_progress - The job has started + processing on the runner. +
      • +
    • + completed - The + status of the job is + completed. +
      • +
    +
    +
    +
    +
    +
    +
    +
    workflow_job object
    +
    +
    + The workflow job. Many + workflow_job keys, such as + head_sha, conclusion, and + started_at are the same as those in a + check_run + object. +
    +
    +
    +
    +
    +
    +
    + workflow_job[status] string +
    +
    +
    + The current status of the job. Can be + queued, in_progress, or + completed. +
    +
    +
    +
    +
    +
    +
    + workflow_job[labels] array +
    +
    +
    + Custom labels for the job. Specified by the + "runs-on" attribute + in the workflow YAML. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_id] + integer +
    +
    +
    + The ID of the runner that is running this job. This + will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_name] + string +
    +
    +
    + The name of the runner that is running this job. + This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_group_id] + integer +
    +
    +
    + The ID of the runner group that is running this job. + This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    + workflow_job[runner_group_name] + string +
    +
    +
    + The name of the runner group that is running this + job. This will be null as long as + workflow_job[status] is + queued. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    + + +

    Webhook payload example

    +
    + { "action": "in_progress", "workflow_job": { "id": 2832853555, + "run_id": 940463255, "run_url": + "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255", + "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55", "head_sha": + "e3103f8eb03e1ad7f2331c5446b23c070fc54055", "url": + "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555", + "html_url": + "https://github.com/octo-org/example-workflow/runs/2832853555", + "status": "in_progress", "conclusion": null, "started_at": + "2021-06-15T19:22:27Z", "completed_at": null, "name": "Test + workflow", "steps": [ { "name": "Set up job", "status": + "in_progress", "conclusion": null, "number": 1, "started_at": + "2021-06-15T19:22:27.000Z", "completed_at": null } ], + "check_run_url": + "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555", + "labels": [ "gpu", "db-app", "dc-03" ], "runner_id": 1, + "runner_name": "my runner", "runner_group_id": 2, + "runner_group_name": "my runner group" }, "repository": { "id": + 376034443, "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55", "name": + "example-workflow", "full_name": "octo-org/example-workflow", + "private": true, "owner": { "login": "octo-org", "id": 33435655, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", "type": + "Organization", "site_admin": false }, "html_url": + "https://github.com/octo-org/example-workflow", "description": + "Test workflow", "fork": false, "url": + "https://api.github.com/repos/octo-org/example-workflow", + "forks_url": + "https://api.github.com/repos/octo-org/example-workflow/forks", + "keys_url": + "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}", + "collaborators_url": + "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}", + "teams_url": + "https://api.github.com/repos/octo-org/example-workflow/teams", + "hooks_url": + "https://api.github.com/repos/octo-org/example-workflow/hooks", + "issue_events_url": + "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}", + "events_url": + "https://api.github.com/repos/octo-org/example-workflow/events", + "assignees_url": + "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}", + "branches_url": + "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}", + "tags_url": + "https://api.github.com/repos/octo-org/example-workflow/tags", + "blobs_url": + "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}", + "trees_url": + "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}", + "statuses_url": + "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}", + "languages_url": + "https://api.github.com/repos/octo-org/example-workflow/languages", + "stargazers_url": + "https://api.github.com/repos/octo-org/example-workflow/stargazers", + "contributors_url": + "https://api.github.com/repos/octo-org/example-workflow/contributors", + "subscribers_url": + "https://api.github.com/repos/octo-org/example-workflow/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/example-workflow/subscription", + "commits_url": + "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}", + "git_commits_url": + "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}", + "comments_url": + "https://api.github.com/repos/octo-org/example-workflow/comments{/number}", + "issue_comment_url": + "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}", + "contents_url": + "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}", + "compare_url": + "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}", + "merges_url": + "https://api.github.com/repos/octo-org/example-workflow/merges", + "archive_url": + "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}", + "downloads_url": + "https://api.github.com/repos/octo-org/example-workflow/downloads", + "issues_url": + "https://api.github.com/repos/octo-org/example-workflow/issues{/number}", + "pulls_url": + "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}", + "milestones_url": + "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}", + "notifications_url": + "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}", + "labels_url": + "https://api.github.com/repos/octo-org/example-workflow/labels{/name}", + "releases_url": + "https://api.github.com/repos/octo-org/example-workflow/releases{/id}", + "deployments_url": + "https://api.github.com/repos/octo-org/example-workflow/deployments", + "created_at": "2021-06-11T13:29:13Z", "updated_at": + "2021-06-11T13:33:01Z", "pushed_at": "2021-06-11T13:32:58Z", + "git_url": "git://github.com/octo-org/example-workflow.git", + "ssh_url": "git@github.com:octo-org/example-workflow.git", + "clone_url": "https://github.com/octo-org/example-workflow.git", + "svn_url": "https://github.com/octo-org/example-workflow", + "homepage": null, "size": 1, "stargazers_count": 0, + "watchers_count": 0, "language": null, "has_issues": true, + "has_projects": true, "has_downloads": true, "has_wiki": true, + "has_pages": false, "forks_count": 0, "mirror_url": null, + "archived": false, "disabled": false, "open_issues_count": 0, + "license": null, "forks": 0, "open_issues": 0, "watchers": 0, + "default_branch": "main" }, "organization": { "login": "octo-org", + "id": 33435655, "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", + "url": "https://api.github.com/orgs/octo-org", "repos_url": + "https://api.github.com/orgs/octo-org/repos", "events_url": + "https://api.github.com/orgs/octo-org/events", "hooks_url": + "https://api.github.com/orgs/octo-org/hooks", "issues_url": + "https://api.github.com/orgs/octo-org/issues", "members_url": + "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": + "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "description": "octo-org" }, "sender": { "login": "octocat", "id": + 319655, "node_id": "MDQ6VXNlcjMxOTY1NQ55", "avatar_url": + "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", + "gravatar_id": "", "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", "followers_url": + "https://api.github.com/users/octocat/followers", "following_url": + "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": + "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": + "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": + "https://api.github.com/users/octocat/received_events", "type": + "User", "site_admin": true } } +
    + + +
    +
    +

    + workflow_run +

    +
    +
    + When a GitHub Actions workflow run is requested or completed. For + more information, see "Events that trigger workflows." +
    +

    Availability for workflow_run

    +
      +
    • + GitHub Apps with Actions or + Contents permissions +
      • +
    +

    Webhook payload object for workflow_run

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Headers
    Name, Type, Description
    Body parameters
    Name, Type, Description
    +
    +
    action string
    +
    +
    + The action that was performed. Can be one of + requested or completed. +
    +
    +
    +
    +
    +
    +
    workflow_run object
    +
    +
    + The workflow run. Includes information such as + artifacts_url, + check_suite_id, + conclusion, head_branch, + and head_sha. +
    +
    +
    +
    +
    +
    +
    workflow object
    +
    +
    + The workflow that generated the workflow run. +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    + Webhook payloads contain the + organization + object when the webhook is configured for an + organization or the event occurs from activity in a + repository owned by an organization. +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    + The + repository + where the event occurred. +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    The user that triggered the event.
    +
    +
    +
    +
    +
    +
    +

    Webhook payload example

    +
    + { "action": "completed", "organization": { "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "description": "", "events_url": + "https://api.github.com/orgs/Octocoders/events", "hooks_url": + "https://api.github.com/orgs/Octocoders/hooks", "id": 33435682, + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "login": "Codertocat", "members_url": + "https://api.github.com/orgs/Octocoders/members{/member}", + "node_id": "MDQ6VXNlcjIxMDMxMDY3", "public_members_url": + "https://api.github.com/orgs/Octocoders/public_members{/member}", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "url": "https://api.github.com/orgs/Codertocat" }, "repository": { + "archive_url": + "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "archived": false, "assignees_url": + "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "collaborators_url": + "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "compare_url": + "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "created_at": "2020-07-29T09:57:16Z", "default_branch": "main", + "deployments_url": + "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "description": null, "disabled": false, "downloads_url": + "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "events_url": + "https://api.github.com/repos/Codertocat/Hello-World/events", + "fork": false, "forks": 0, "forks_count": 0, "forks_url": + "https://api.github.com/repos/Codertocat/Hello-World/forks", + "full_name": "Codertocat/Hello-World", "git_commits_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "has_downloads": true, "has_issues": true, "has_pages": false, + "has_projects": true, "has_wiki": true, "homepage": null, + "hooks_url": + "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "html_url": "https://github.com/Codertocat/Hello-World", "id": + 283462325, "issue_comment_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "keys_url": + "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "language": null, "languages_url": + "https://api.github.com/repos/Codertocat/Hello-World/languages", + "license": null, "merges_url": + "https://api.github.com/repos/Codertocat/Hello-World/merges", + "milestones_url": + "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "mirror_url": null, "name": "Hello-World", "node_id": + "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=", "notifications_url": + "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": + "https://avatars1.githubusercontent.com/u/21031067?v=4", + "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/Codertocat", + "id": 33435682, "login": "Codertocat", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy", "organizations_url": + "https://api.github.com/users/Codertocat/orgs", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/Codertocat" + }, "private": true, "pulls_url": + "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "pushed_at": "2020-07-29T10:06:16Z", "releases_url": + "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "size": 0, "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "stargazers_count": 0, "stargazers_url": + "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "statuses_url": + "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": + "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "svn_url": "https://github.com/Codertocat/Hello-World", + "tags_url": + "https://api.github.com/repos/Codertocat/Hello-World/tags", + "teams_url": + "https://api.github.com/repos/Codertocat/Hello-World/teams", + "trees_url": + "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "updated_at": "2020-07-29T10:06:18Z", "url": + "https://api.github.com/repos/Codertocat/Hello-World", "watchers": + 0, "watchers_count": 0 }, "sender": { "avatar_url": + "https://avatars3.githubusercontent.com/u/54248166?v=4", + "events_url": + "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": + "https://api.github.com/users/Codertocat/followers", + "following_url": + "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": + "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/Codertocat", + "id": 54248166, "login": "Codertocat", "node_id": + "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", "organizations_url": + "https://api.github.com/users/Codertocat/orgs", + "received_events_url": + "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": true, "starred_url": + "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/Codertocat/subscriptions", "type": + "User", "url": "https://api.github.com/users/Codertocat" }, + "workflow": { "badge_url": + "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg", + "created_at": "2021-12-15T20:11:38.000Z", "html_url": + "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml", + "id": 16340987, "name": "Manually triggered workflow", "node_id": + "W_kwDOF6lyTM4A-Vf7", "path": ".github/workflows/syntax.yml", + "state": "active", "updated_at": "2021-12-16T18:40:41.000Z", + "url": + "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" + }, "workflow_run": { "artifacts_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts", + "cancel_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel", + "check_suite_id": 4683454167, "check_suite_node_id": + "CS_kwDOF6lyTM8AAAABFyfW1w", "check_suite_url": + "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167", + "conclusion": null, "created_at": "2021-12-16T19:37:22Z", "event": + "workflow_dispatch", "head_branch": "main", "head_commit": { + "author": { "email": "octocat@github.com", "name": "Mona Lisa" }, + "committer": { "email": "noreply@github.com", "name": "GitHub" }, + "id": "5779607b49aab1200488439f02372c57b4f75444", "message": + "Update milestone-created.yml", "timestamp": + "2021-12-16T19:37:14Z", "tree_id": + "8181cee091cf9627ac07c3cc4b94c015a1d56706" }, "head_repository": { + "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 396980812, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "owner": { "avatar_url": + "https://avatars.githubusercontent.com/u/79927191?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": true, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, + "head_sha": "5779607b49aab1200488439f02372c57b4f75444", + "html_url": + "https://github.com/octo-org/octo-repo/actions/runs/1589141559", + "id": 1589141559, "jobs_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs", + "logs_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs", + "name": "Manually triggered workflow", "node_id": + "WFR_kwLOF6lyTM5euGA3", "previous_attempt_url": null, + "pull_requests": [], "repository": { "archive_url": + "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": + "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": + "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": + "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": + "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": + "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": + "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": + "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": + "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": + "https://api.github.com/repos/octo-org/octo-repo/deployments", + "description": null, "downloads_url": + "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": + "https://api.github.com/repos/octo-org/octo-repo/events", "fork": + false, "forks_url": + "https://api.github.com/repos/octo-org/octo-repo/forks", + "full_name": "octo-org/octo-repo", "git_commits_url": + "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": + "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": + "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": + "https://api.github.com/repos/octo-org/octo-repo/hooks", + "html_url": "https://github.com/octo-org/octo-repo", "id": + 396980812, "issue_comment_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": + "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": + "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": + "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": + "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": + "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": + "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": + "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "name": "octo-repo", "node_id": + "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", "notifications_url": + "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "owner": { "avatar_url": + "https://avatars.githubusercontent.com/u/79927191?v=4", + "events_url": + "https://api.github.com/users/octo-org/events{/privacy}", + "followers_url": + "https://api.github.com/users/octo-org/followers", + "following_url": + "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": + "https://api.github.com/users/octo-org/gists{/gist_id}", + "gravatar_id": "", "html_url": "https://github.com/octo-org", + "id": 79927191, "login": "octo-org", "node_id": + "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", "organizations_url": + "https://api.github.com/users/octo-org/orgs", + "received_events_url": + "https://api.github.com/users/octo-org/received_events", + "repos_url": "https://api.github.com/users/octo-org/repos", + "site_admin": false, "starred_url": + "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": + "https://api.github.com/users/octo-org/subscriptions", "type": + "Organization", "url": "https://api.github.com/users/octo-org" }, + "private": true, "pulls_url": + "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": + "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": + "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": + "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": + "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": + "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": + "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": + "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": + "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, + "rerun_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun", + "run_attempt": 1, "run_number": 36, "run_started_at": + "2021-12-16T19:37:22Z", "status": "queued", "updated_at": + "2021-12-16T19:37:22Z", "url": + "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559", + "workflow_id": 16340987, "workflow_url": + "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" + } } +
    +
    diff --git a/cache/github.ae/webhook-events-and-payloads.html b/cache/github.ae/webhook-events-and-payloads.html index e05629b9e..776f94e1e 100644 --- a/cache/github.ae/webhook-events-and-payloads.html +++ b/cache/github.ae/webhook-events-and-payloads.html @@ -1,17785 +1,19139 @@
    -

    Webhook events and payloads

    -
    -
    -

    In this article

    - + + +
    +
    +

    Webhook events and payloads

    +
    -
    -
    +
    +

    - For each webhook event, you can review when the event occurs, an example - payload, and descriptions about the payload object parameters. + Learn about when each webhook event occurs and what the payload contains.

    -
    -
    -
    -

    - When configuring a webhook, you can use the UI or API to choose which - events will send you payloads. Only subscribing to the specific events - you plan on handling limits the number of HTTP requests to your server. - You can also subscribe to all current and future events. By default, - webhooks are only subscribed to the push event. You can change the list - of subscribed events anytime. -

    -

    - You can create webhooks that subscribe to the events listed on this - page. Each webhook event includes a description of the webhook - properties and an example payload. For more information, see "Creating webhooks." -

    -

    +
    +

    In this article

    +

    -

    - Each webhook event payload also contains properties unique to the event. - You can find the unique properties in the individual event type - sections. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - Most webhook payloads contain an action property that - contains the specific activity that triggered the event. -
    senderobject - The user that triggered the event. This property is included in - every webhook payload. -
    repositoryobject - The - repository - where the event occurred. Webhook payloads contain the - repository property when the event occurs from - activity in a repository. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. For more information, see "Building GitHub App." -
    -

    - The unique properties for a webhook event are the same properties you'll - find in the payload property when using the - Events API. One exception is the push event. The - unique properties of the push event webhook payload and the - payload property in the Events API differ. The webhook - payload contains more detailed information. -

    -
    -

    - Note: Payloads are capped at 25 MB. If your event - generates a larger payload, a webhook will not be fired. This may - happen, for example, on a create event if many branches - or tags are pushed at once. We suggest monitoring your payload size to - ensure delivery. -

    -
    -

    - - Delivery headers -

    -

    - HTTP POST payloads that are delivered to your webhook's configured URL - endpoint will contain several special headers: -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HeaderDescription
    X-GitHub-EventName of the event that triggered the delivery.
    X-GitHub-Delivery - A - GUID - to identify the delivery. -
    X-GitHub-Enterprise-Version - The version of the GitHub Enterprise Server instance that sent the - HTTP POST payload. -
    X-GitHub-Enterprise-Host - The hostname of the GitHub Enterprise Server instance that sent - the HTTP POST payload. -
    X-Hub-Signature-256 - This header is sent if the webhook is configured with a - secret. This is the HMAC hex digest of the request body, and is - generated using the SHA-256 hash function and the - secret as the HMAC key. -
    -

    - Also, the User-Agent for the requests will have the prefix - GitHub-Hookshot/. -

    -

    - - Example delivery -

    - 
    > POST /payload HTTP/2
-
-> Host: localhost:4567
-> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
-> X-GitHub-Enterprise-Version: 2.15.0
-> X-GitHub-Enterprise-Host: example.com
-> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
-> User-Agent: GitHub-Hookshot/044aadd
-> Content-Type: application/json
-> Content-Length: 6615
-> X-GitHub-Event: issues
-
-> {
->   "action": "opened",
->   "issue": {
->     "url": "https://HOSTNAME/api/v3/repos/octocat/Hello-World/issues/1347",
->     "number": 1347,
->     ...
->   },
->   "repository" : {
->     "id": 1296269,
->     "full_name": "octocat/Hello-World",
->     "owner": {
->       "login": "octocat",
->       "id": 1,
->       ...
->     },
->     ...
->   },
->   "sender": {
->     "login": "octocat",
->     "id": 1,
->     ...
->   }
-> }
    -

    - - branch_protection_rule -

    -

    - Activity related to a branch protection rule. For more information, see - "About branch protection rules." -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Administration repository permission -
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be created, - edited, or deleted. -
    ruleobject - 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. -
    changesobject - If the action was edited, the changes to the rule. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "edited",
-  "rule": {
-    "id": 21796960,
-    "repository_id": 259377789,
-    "name": "production",
-    "created_at": "2021-08-19T12:16:32.000-04:00",
-    "updated_at": "2021-08-19T12:16:32.000-04:00",
-    "pull_request_reviews_enforcement_level": "off",
-    "required_approving_review_count": 1,
-    "dismiss_stale_reviews_on_push": false,
-    "require_code_owner_review": false,
-    "authorized_dismissal_actors_only": false,
-    "ignore_approvals_from_contributors": false,
-    "required_status_checks": [
-      "basic-CI"
-    ],
-    "required_status_checks_enforcement_level": "non_admins",
-    "strict_required_status_checks_policy": false,
-    "signature_requirement_enforcement_level": "off",
-    "linear_history_requirement_enforcement_level": "off",
-    "admin_enforced": false,
-    "allow_force_pushes_enforcement_level": "off",
-    "allow_deletions_enforcement_level": "off",
-    "merge_queue_enforcement_level": "off",
-    "required_deployments_enforcement_level": "off",
-    "required_conversation_resolution_level": "off",
-    "authorized_actors_only": true,
-    "authorized_actor_names": [
-      "Codertocat"
-    ]
-  },
-  "changes": {
-    "authorized_actors_only": {
-      "from": false
-    },
-    "authorized_actor_names": {
-      "from": []
-    }
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2021-03-11T14:54:13Z",
-    "pushed_at": "2021-03-11T14:54:10Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 300,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": false,
-    "has_downloads": true,
-    "has_wiki": false,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 39,
-    "license": null,
-    "forks": 0,
-    "open_issues": 39,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - check_run -

    -

    - Check run activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check runs" REST API. -

    -
    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    -
    -

    - - Availability -

    -
      -
    • - Repository webhooks only receive payloads for the - created and completed event types in a - repository -
      • -
    • - Organization webhooks only receive payloads for the - created and completed event types in - repositories -
      • -
    • - GitHub Apps with Checks read permission receive - payloads for the created and - completed events that occur in the repository where the - app is installed. The app must have Checks write - permission to receive the rerequested and - requested_action event types. The - rerequested and requested_action event type - payloads are only sent to the GitHub App being requested. GitHub Apps - with Checks write permission are automatically - subscribed to this webhook event. -
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • created - A new check run was created.
      • -
    • - completed - The status of the check - run is completed. -
      • -
    • - rerequested - Someone requested to re-run your - check run from the pull request UI. See "About status checks" for more details about the GitHub UI. When you receive a - rerequested action, you'll need to - create a new check run. Only the GitHub App that someone requests to re-run the - check will receive the rerequested payload. -
      • -
    • - requested_action - Someone requested an action - your app provides to be taken. Only the GitHub App someone - requests to perform an action will receive the - requested_action payload. To learn more about - check runs and requested actions, see "Check runs and requested actions." -
      • -
    -
    check_runobject - The - check_run. -
    check_run[status]string - The current status of the check run. Can be queued, - in_progress, or completed. -
    check_run[conclusion]string - The result of the completed check run. Can be one of - success, failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_run[name]stringThe name of the check run.
    check_run[check_suite][id]integerThe id of the check suite that this check run is part of.
    check_run[check_suite][pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    check_run[check_suite][deployment]object - A deployment to a repository environment. This will only be - populated if the check run was created by a GitHub Actions - workflow job that references an environment. -
    requested_actionobjectThe action requested by the user.
    requested_action[identifier]string - The integrator reference of the action requested by the user. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "check_run": {
-    "id": 2,
-    "node_id": "MDg6Q2hlY2tSdW4y",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "external_id": "",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/runs/2",
-    "details_url": "https://octocoders.github.io",
-    "status": "queued",
-    "conclusion": null,
-    "started_at": "2019-05-15T19:39:04Z",
-    "completed_at": null,
-    "output": {
-      "title": null,
-      "summary": null,
-      "text": null,
-      "annotations_count": 0,
-      "annotations_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2/annotations"
-    },
-    "name": "Octocoders-linter",
-    "check_suite": {
-      "id": 9,
-      "node_id": "MDEwOkNoZWNrU3VpdGU5",
-      "head_branch": "changes",
-      "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "status": "queued",
-      "conclusion": null,
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-      "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-      "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "pull_requests": [
-        {
-          "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-          "id": 2,
-          "number": 2,
-          "head": {
-            "ref": "changes",
-            "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-            "repo": {
-              "id": 118,
-              "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          },
-          "base": {
-            "ref": "master",
-            "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-            "repo": {
-              "id": 118,
-              "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-              "name": "Hello-World"
-            }
-          }
-        }
-      ],
-      "app": {
-        "id": 2,
-        "node_id": "MDM6QXBwMg==",
-        "owner": {
-          "login": "Octocoders",
-          "id": 6,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-          "html_url": "https://octocoders.github.io/Octocoders",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "name": "octocoders-linter",
-        "description": "",
-        "external_url": "https://octocoders.github.io",
-        "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-        "created_at": "2019-05-15T15:41:35Z",
-        "updated_at": "2019-05-15T15:41:35Z",
-        "permissions": {
-          "administration": "write",
-          "checks": "write",
-          "contents": "write",
-          "deployments": "write",
-          "issues": "write",
-          "metadata": "read",
-          "pages": "write",
-          "pull_requests": "write",
-          "repository_hooks": "write",
-          "repository_projects": "write",
-          "vulnerability_alerts": "read",
-          "statuses": "write",
-          "members": "write",
-          "organization_user_blocking": "write",
-          "organization_projects": "write",
-          "team_discussions": "write",
-          "organization_hooks": "write",
-          "repository_pre_receive_hooks": "write",
-          "organization_pre_receive_hooks": "write"
-        },
-        "events": [
-          "check_run",
-          "check_suite",
-          "commit_comment",
-          "create",
-          "delete",
-          "deployment",
-          "deployment_status",
-          "fork",
-          "gollum",
-          "issues",
-          "issue_comment",
-          "label",
-          "member",
-          "membership",
-          "milestone",
-          "organization",
-          "page_build",
-          "project",
-          "project_card",
-          "project_column",
-          "public",
-          "pull_request",
-          "pull_request_review",
-          "pull_request_review_comment",
-          "push",
-          "release",
-          "repository",
-          "status",
-          "team",
-          "team_add",
-          "watch"
-        ]
-      },
-      "created_at": "2019-05-15T19:38:27Z",
-      "updated_at": "2019-05-15T19:38:27Z"
-    },
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.github.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "deployment": {
-      "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
-      "id": 326191728,
-      "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
-      "task": "deploy",
-      "original_environment": "lab",
-      "environment": "lab",
-      "description": null,
-      "created_at": "2021-02-18T08:22:48Z",
-      "updated_at": "2021-02-18T09:47:16Z",
-      "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
-      "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
-    }
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - check_suite -

    -

    - Check suite activity has occurred. The type of activity is specified in - the action property of the payload object. For more - information, see the "check suites" REST API. -

    -
    -

    - Note: The Checks API only looks for pushes in the - repository where the check suite or check run were 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. -

    -
    -

    - - Availability -

    -
      -
    • - Repository webhooks only receive payloads for the - completed event types in a repository -
      • -
    • - Organization webhooks only receive payloads for the - completed event types in repositories -
      • -
    • - GitHub Apps with Checks read permission receive - payloads for the created and - completed events that occur in the repository where the - app is installed. The app must have Checks write - permission to receive the requested and - rerequested event types. The requested and - rerequested event type payloads are only sent to the - GitHub App being requested. GitHub Apps with - Checks write permission are automatically subscribed - to this webhook event. -
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be: -
      -
    • - completed - All check runs in a check suite have - completed. -
      • -
    • - requested - Occurs when new code is pushed to the - app's repository. When you receive the - requested action events, you'll need to - create a new check run. -
      • -
    • - rerequested - Occurs when someone requests to - re-run the entire check suite from the pull request UI. When - you receive the rerequested action events, you'll - need to - create a new check run. See "About status checks" for more details about the GitHub UI. -
      • -
    -
    check_suiteobject - The - check_suite. -
    check_suite[head_branch]stringThe head branch name the changes are on.
    check_suite[head_sha]stringThe SHA of the most recent commit for this check suite.
    check_suite[status]string - The summary status for all check runs that are part of the check - suite. Can be queued, requested, - in_progress, or completed. -
    check_suite[conclusion]string - The summary conclusion for all check runs that are part of the - check suite. Can be one of success, - failure, neutral, - cancelled, timed_out, - action_required or stale. This value - will be null until the check run has - completed. -
    check_suite[url]stringURL that points to the check suite API resource.
    check_suite[pull_requests]array - An array of pull requests that match this check suite. A pull - request matches a check suite if they have the same - head_branch.

    Note: -
      -
    • - The head_sha of the check suite can differ from - the sha of the pull request if subsequent pushes - are made into the PR. -
      • -
    • - When the check suite's head_branch is in a forked - repository it will be null and the - pull_requests array will be empty. -
      • -
    -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "completed",
-  "check_suite": {
-    "id": 9,
-    "node_id": "MDEwOkNoZWNrU3VpdGU5",
-    "head_branch": "changes",
-    "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "status": "completed",
-    "conclusion": "success",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
-    "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "after": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "pull_requests": [
-      {
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-        "id": 2,
-        "number": 2,
-        "head": {
-          "ref": "changes",
-          "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        },
-        "base": {
-          "ref": "master",
-          "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-          "repo": {
-            "id": 118,
-            "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-            "name": "Hello-World"
-          }
-        }
-      }
-    ],
-    "app": {
-      "id": 2,
-      "node_id": "MDM6QXBwMg==",
-      "owner": {
-        "login": "Octocoders",
-        "id": 6,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-        "html_url": "https://octocoders.github.io/Octocoders",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "name": "octocoders-linter",
-      "description": "",
-      "external_url": "https://octocoders.github.io",
-      "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
-      "created_at": "2019-05-15T15:41:35Z",
-      "updated_at": "2019-05-15T15:41:35Z",
-      "permissions": {
-        "administration": "write",
-        "checks": "write",
-        "contents": "write",
-        "deployments": "write",
-        "issues": "write",
-        "metadata": "read",
-        "pages": "write",
-        "pull_requests": "write",
-        "repository_hooks": "write",
-        "repository_projects": "write",
-        "vulnerability_alerts": "read",
-        "statuses": "write",
-        "members": "write",
-        "organization_user_blocking": "write",
-        "organization_projects": "write",
-        "team_discussions": "write",
-        "organization_hooks": "write",
-        "repository_pre_receive_hooks": "write",
-        "organization_pre_receive_hooks": "write"
-      },
-      "events": [
-        "check_run",
-        "check_suite",
-        "commit_comment",
-        "create",
-        "delete",
-        "deployment",
-        "deployment_status",
-        "fork",
-        "gollum",
-        "issues",
-        "issue_comment",
-        "label",
-        "member",
-        "membership",
-        "milestone",
-        "organization",
-        "page_build",
-        "project",
-        "project_card",
-        "project_column",
-        "public",
-        "pull_request",
-        "pull_request_review",
-        "pull_request_review_comment",
-        "push",
-        "release",
-        "repository",
-        "status",
-        "team",
-        "team_add",
-        "watch"
-      ]
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:39:09Z",
-    "latest_check_runs_count": 1,
-    "check_runs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs",
-    "head_commit": {
-      "id": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
-      "message": "Update README.md",
-      "timestamp": "2019-05-15T19:38:01Z",
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@octocoders.github.io"
-      },
-      "committer": {
-        "name": "Codertocat",
-        "email": "Codertocat@octocoders.github.io"
-      }
-    }
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - code_scanning_alert -

    -

    - Activity related to code scanning alerts in a repository. The type of - activity is specified in the action property of the payload object. For - more information, see "About code scanning." -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • - GitHub Apps with Code scanning alerts permission -
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of - created, reopened_by_user, - closed_by_user, fixed, - appeared_in_branch, or reopened. -
    alertobjectThe code scanning alert involved in the event.
    refstring - 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. -
    commit_oidstring - 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. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobject - If the action is reopened_by_user or - closed_by_user, the sender object will - be the user that triggered the event. The - sender object is github-enterprise for - all other actions. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "reopened",
-  "alert": {
-    "number": 10,
-    "created_at": "2020-07-22T14:06:31Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/code-scanning/alerts/10",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
-    "instances": [
-      {
-        "ref": "refs/heads/main",
-        "analysis_key": ".github/workflows/workflow.yml:upload",
-        "environment": "{}",
-        "state": "open"
-      }
-    ],
-    "state": "open",
-    "dismissed_by": null,
-    "dismissed_at": null,
-    "dismissed_reason": null,
-    "rule": {
-      "id": "Style/FrozenStringLiteralComment",
-      "severity": "note",
-      "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default."
-    },
-    "tool": {
-      "name": "Rubocop",
-      "version": null
-    }
-  },
-  "ref": "refs/heads/main",
-  "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  }
-}
-
    -
    -

    - - commit_comment -

    -

    - A commit comment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "commit comment" REST API. -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    commentobject - The - commit comment - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78#commitcomment-2",
-    "id": 2,
-    "node_id": "MDEzOkNvbW1pdENvbW1lbnQy",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "position": null,
-    "line": null,
-    "path": null,
-    "commit_id": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "created_at": "2019-05-15T19:38:09Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "author_association": "OWNER",
-    "body": "This is a really good change! :+1:"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - create -

    -

    - A Git branch or tag is created. For more information, see the "Git database" REST API. -

    -
    -

    - Note: You will not receive a webhook for this event - when you create more than three tags at once. -

    -
    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The - git ref - resource. -
    ref_typestring - The type of Git ref object created in the repository. Can be - either branch or tag. -
    master_branchstring - The name of the repository's default branch (usually - main). -
    descriptionstringThe repository's current description.
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "master_branch": "master",
-  "description": null,
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:22Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - delete + tabindex="0" + aria-labelledby=":R10djmqn6:--label " + id=":R10djmqn6:" + aria-current="false" + href="#about-webhook-events-and-payloads" + >
    + About webhook events and payloads +
    + +
  • +
    + branch_protection_configuration +
    +
    • +
  • +
    + branch_protection_rule +
    +
    • +
  • +
    + bypass_request_push_ruleset +
    +
    • +
  • +
    + bypass_request_secret_scanning +
    +
    • +
  • +
    + check_run +
    +
    • +
  • +
    + check_suite +
    +
    • +
  • +
    + code_scanning_alert +
    +
    • +
  • +
    + commit_comment +
    +
    • +
  • +
    + create +
    +
    • +
  • +
    + custom_property +
    +
    • +
  • +
    + custom_property_values +
    +
    • +
  • +
    + delete +
    +
    • +
  • +
    + dependabot_alert +
    +
    • +
  • +
    + deploy_key +
    +
    • +
  • +
    + deployment +
    +
    • +
  • +
    + deployment_protection_rule +
    +
    • +
  • +
    + deployment_review +
    +
    • +
  • +
    + deployment_status +
    +
    • +
  • +
    + discussion +
    +
    • +
  • +
    + discussion_comment +
    +
    • +
  • +
    + fork +
    +
    • +
  • +
    + github_app_authorization +
    +
    • +
  • +
    + gollum +
    +
    • +
  • +
    + installation +
    +
    • +
  • +
    + installation_repositories +
    +
    • +
  • +
    + installation_target +
    +
    • +
  • +
    + issue_comment +
    +
    • +
  • +
    + issues +
    +
    • +
  • +
    + label +
    +
    • +
  • +
    + marketplace_purchase +
    +
    • +
  • +
    + member +
    +
    • +
  • +
    + membership +
    +
    • +
  • +
    + merge_group +
    +
    • +
  • +
    + meta +
    +
    • +
  • +
    + milestone +
    +
    • +
  • +
    + org_block +
    +
    • +
  • +
    + organization +
    +
    • +
  • +
    + package +
    +
    • +
  • +
    + page_build +
    +
    • +
  • +
    + personal_access_token_request +
    +
    • +
  • +
    + ping +
    +
    • +
  • +
    + project_card +
    +
    • +
  • +
    + project +
    +
    • +
  • +
    + project_column +
    +
    • +
  • +
    + projects_v2 +
    +
    • +
  • +
    + projects_v2_item +
    +
    • +
  • +
    + projects_v2_status_update +
    +
    • +
  • +
    + public +
    +
    • +
  • +
    + pull_request +
    +
    • +
  • +
    + pull_request_review_comment +
    +
    • +
  • +
    + pull_request_review +
    +
    • +
  • +
    + pull_request_review_thread +
    +
    • +
  • +
    + push +
    +
    • +
  • +
    + registry_package +
    +
    • +
  • +
    + release +
    +
    • +
  • +
    + repository_advisory +
    +
    • +
  • +
    + repository +
    +
    • +
  • +
    + repository_dispatch +
    +
    • +
  • +
    + repository_import +
    +
    • +
  • +
    + repository_ruleset +
    +
    • +
  • +
    + repository_vulnerability_alert +
    +
    • +
  • +
    + secret_scanning_alert +
    +
    • +
  • +
    + secret_scanning_alert_location +
    +
    • +
  • +
    + security_advisory +
    +
    • +
  • +
    + security_and_analysis +
    +
    • +
  • +
    + sponsorship +
    +
    • +
  • +
    + star +
    +
    • +
  • +
    + status +
    +
    • +
  • +
    + team_add +
    +
    • +
  • +
    + team +
    +
    • +
  • +
    + watch +
    +
    • +
  • +
    + workflow_dispatch +
    +
    • +
  • +
    + workflow_job +
    +
    • +
  • +
    + workflow_run +
    +
    • + + +

    +
    +
    +
    +

    + About webhook events and payloads

    - A Git branch or tag is deleted. For more information, see the "Git database" REST API. + You can create webhooks that subscribe to the events listed on this + page. To limit the number of HTTP requests to your server, you should + only subscribe to the specific events that you plan on handling. For + more information, see "Creating webhooks."

    -
    -

    - Note: You will not receive a webhook for this event - when you delete more than three tags at once. -

    -
    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    refstring - The - git ref - resource. -
    ref_typestring - The type of Git ref object deleted in the repository. Can be - either branch or tag. -
    pusher_typestring - The pusher type for the event. Can be either user or - a deploy key. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "simple-tag",
-  "ref_type": "tag",
-  "pusher_type": "user",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - deploy_key -

    - A deploy key is added or removed from a repository. The type of activity - is specified in the action property of the payload object. - For more information, see the "Deploy keys" REST API. + Each webhook event on this page includes a description of the webhook + properties for that event. If the event has multiple actions, the + properties corresponding to each action are included.

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be either created or - deleted. -
    keyobject - The - deploy key - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "key": {
-    "id": 100,
-    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z",
-    "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100",
-    "title": "hey-its-a-deploy-key",
-    "verified": true,
-    "created_at": "2019-04-02T17:37:07Z",
-    "read_only": true
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - deployment -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployment" REST API. + Each event is only available to specific types of webhooks. For example, + an organization webhook can subscribe to the team event, + but a repository webhook cannot. The description of each webhook event + lists the availability for that event. For more information, see "Types of webhooks."

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Deployments permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deploymentobject - The - deployment. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example +

    + Payload cap

    -
    - 
    {
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:20Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - deployment_status -

    - A deployment is created. The type of activity is specified in the - action property of the payload object. For more - information, see the "deployments" REST API. + Payloads are capped at 25 MB. If an event generates a larger payload, + GitHub will not deliver a payload for that webhook event. This may + happen, for example, on a create event if many branches or + tags are pushed at once. We suggest monitoring your payload size to + ensure delivery.

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Deployments permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be created.
    deployment_statusobject - The - deployment status. -
    deployment_status["state"]string - The new state. Can be pending, success, - failure, or error. -
    deployment_status["target_url"]stringThe optional link added to the status.
    deployment_status["description"]string - The optional human-readable description added to the status. -
    deploymentobject - The - deployment - that this status is associated with. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example +

    + Delivery headers

    -
    - 
    {
-  "deployment_status": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2",
-    "id": 2,
-    "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy",
-    "state": "success",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "description": "",
-    "environment": "production",
-    "target_url": "",
-    "created_at": "2019-05-15T19:38:21Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "deployment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "deployment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
-    "id": 2,
-    "node_id": "MDEwOkRlcGxveW1lbnQy",
-    "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-    "ref": "master",
-    "task": "deploy",
-    "payload": {},
-    "original_environment": "production",
-    "environment": "production",
-    "description": null,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:20Z",
-    "updated_at": "2019-05-15T19:38:21Z",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - enterprise -

    - A site or repository administrator enables or disables anonymous Git - read access. See "Allowing admins to enable anonymous Git read access to public - repositories" for more details. This event is not available in the Events API. + HTTP POST payloads that are delivered to your webhook's configured URL + endpoint will contain several special headers:

    -

    - - Availability -

    • - GitHub Enterprise webhooks. For more information, "Global webhooksX-GitHub-Hook-ID: The unique identifier of the webhook. +
      • +
    • + X-GitHub-Event: The name of the event that triggered the + delivery. +
      • +
    • + X-GitHub-Delivery: A globally unique identifier (GUID) to + identify the event. +
      • +
    • + X-Hub-Signature: This header is sent if the webhook is + configured with a secret. This is the HMAC hex digest of + the request body, and is generated using the SHA-1 hash function and + the secret as the HMAC key. + X-Hub-Signature is provided for compatibility with + existing integrations. We recommend that you use the more secure + X-Hub-Signature-256 instead. +
      • +
    • + X-Hub-Signature-256: This header is sent if the webhook + is configured with a secret. This is the HMAC hex digest + of the request body, and is generated using the SHA-256 hash function + and the secret as the HMAC key. For more + information, see "Validating webhook deliveries."
      • +
    • + User-Agent: This header will always have the prefix + GitHub-Hookshot/. +
      • +
    • + X-GitHub-Hook-Installation-Target-Type: The type of + resource where the webhook was created. +
      • +
    • + X-GitHub-Hook-Installation-Target-ID: The unique + identifier of the resource where the webhook was created. +
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action performed. Can be - anonymous_access_enabled or - anonymous_access_disabled. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "anonymous_access_enabled",
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - fork -

    -

    - A user forks a repository. For more information, see the "forks" REST API. -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    forkeeobject - The created - repository - resource. -
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "forkee": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "public": true
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    -
    -

    - - github_app_authorization -

    -

    - When someone revokes their authorization of a GitHub App, this event - occurs. A GitHub App receives this webhook by default and cannot - unsubscribe from this event. -

    -

    - Anyone 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 user-to-server requests, which require GitHub App - authorization, see "Identifying and authorizing users for GitHub Apps." -

    -

    - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstringThe action performed. Can be revoked.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "revoked",
-  "sender": {
-    "login": "octocat",
-    "id": 1,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - gollum -

    - A wiki page is created or updated. For more information, see "About wikisExample webhook delivery."

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Contents permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    pagesarrayThe pages that were updated.
    pages[][page_name]stringThe name of the page.
    pages[][title]stringThe current page title.
    pages[][action]string - The action that was performed on the page. Can be - created or edited. -
    pages[][sha]stringThe latest commit SHA of the page.
    pages[][html_url]stringPoints to the HTML wiki page.
    repositoryobject - The - repository - where the event occurred. -
    organizationobject - Webhook payloads contain the - organization - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "pages": [
-    {
-      "page_name": "Home",
-      "title": "Home",
-      "summary": null,
-      "action": "edited",
-      "sha": "4bbb6df16cb5ce1818602bf634e94ebdac7ae385",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home"
-    }
-  ],
-  "repository": {
-    "id": 122,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://avatars.octocoders.github.io/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-10-04T18:29:19Z",
-    "updated_at": "2018-10-04T18:29:21Z",
-    "pushed_at": "2018-10-04T18:29:59Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "rachmari",
-    "id": 3,
-    "node_id": "MDQ6VXNlcjM=",
-    "avatar_url": "https://avatars.octocoders.github.io/u/3?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/rachmari",
-    "html_url": "https://octocoders.github.io/rachmari",
-    "followers_url": "https://octocoders.github.io/api/v3/users/rachmari/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/rachmari/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/rachmari/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/rachmari/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/rachmari/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    -
    -

    - - installation -

    -

    - Activity related to a GitHub App installation. The type of activity is - specified in the action property of the payload object. For - more information, see the "GitHub App installation" REST API. -

    -

    - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • created - Someone installs a GitHub App.
      • -
    • deleted - Someone uninstalls a GitHub App
      • -
    • - suspend - Someone suspends a GitHub App - installation. -
      • -
    • - unsuspend - Someone unsuspends a GitHub App - installation. -
      • -
    • - new_permissions_accepted - Someone accepts new - permissions for a GitHub App installation. When a GitHub App - owner requests new permissions, the person who installed the - GitHub App must accept the new permissions request. -
      • -
    -
    repositoriesarray - An array of repository objects that the installation can access. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example +

    + Example webhook delivery

    -
    - 
    {
-  "action": "deleted",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-      "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-      "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-      "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-      "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-      "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "checks": "write",
-      "contents": "write",
-      "deployments": "write",
-      "issues": "write",
-      "pages": "write",
-      "pull_requests": "write",
-      "repository_hooks": "write",
-      "repository_projects": "write",
-      "statuses": "write",
-      "repository_pre_receive_hooks": "write",
-      "metadata": "read",
-      "vulnerability_alerts": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": "2019-05-15T19:37:38.000Z",
-    "updated_at": "2019-05-15T19:37:38.000Z",
-    "single_file_name": null
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
-    "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
-    "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
-    "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
-    "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
-    "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    -
    -

    - - installation_repositories -

    - Activity related to repositories being added to a GitHub App - installation. The type of activity is specified in the - action property of the payload object. For more - information, see the "GitHub App installation" REST API. + You can choose to have payloads delivered in JSON format + (application/json) or as URL-encoded data + (x-www-form-urlencoded). Following is an example of a + webhook POST request that uses the JSON format.

    -

    - - Availability -

    -
      -
    • GitHub Apps
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. Can be either added or - removed. -
    repository_selectionstring - The choice of repositories the installation is on. Can be either - selected or all. -
    repositories_addedarray - An array of repository objects, which were added to the - installation. -
    repositories_removedarray - An array of repository objects, which were removed from the - installation. -
    installationobjectThe GitHub App installation.
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "installation": {
-    "id": 5,
-    "account": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "repository_selection": "selected",
-    "access_tokens_url": "https://octocoders.github.io/api/v3/app/installations/5/access_tokens",
-    "repositories_url": "https://octocoders.github.io/api/v3/installation/repositories",
-    "html_url": "https://octocoders.github.io/settings/installations/5",
-    "app_id": 2,
-    "target_id": 4,
-    "target_type": "User",
-    "permissions": {
-      "administration": "write",
-      "repository_pre_receive_hooks": "write",
-      "statuses": "write",
-      "repository_projects": "write",
-      "repository_hooks": "write",
-      "pull_requests": "write",
-      "pages": "write",
-      "issues": "write",
-      "deployments": "write",
-      "contents": "write",
-      "checks": "write",
-      "vulnerability_alerts": "read",
-      "metadata": "read"
-    },
-    "events": [
-      "check_run",
-      "check_suite",
-      "commit_comment",
-      "create",
-      "delete",
-      "deployment",
-      "deployment_status",
-      "fork",
-      "gollum",
-      "issues",
-      "issue_comment",
-      "label",
-      "member",
-      "membership",
-      "milestone",
-      "organization",
-      "page_build",
-      "project",
-      "project_card",
-      "project_column",
-      "public",
-      "pull_request",
-      "pull_request_review",
-      "pull_request_review_comment",
-      "push",
-      "release",
-      "repository",
-      "status",
-      "team",
-      "team_add",
-      "watch"
-    ],
-    "created_at": 1557949058,
-    "updated_at": 1557949058,
-    "single_file_name": null
-  },
-  "repository_selection": "selected",
-  "repositories_added": [
-    {
-      "id": 119,
-      "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=",
-      "name": "Space",
-      "full_name": "Codertocat/Space",
-      "private": false
-    }
-  ],
-  "repositories_removed": [],
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
+      
    > POST /payload HTTP/2
+
+> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
+> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
+> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c
+> User-Agent: GitHub-Hookshot/044aadd
+> Content-Type: application/json
+> Content-Length: 6615
+> X-GitHub-Event: issues
+> X-GitHub-Hook-ID: 292430182
+> X-GitHub-Hook-Installation-Target-ID: 79929171
+> X-GitHub-Hook-Installation-Target-Type: repository
+
+> {
+>   "action": "opened",
+>   "issue": {
+>     "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+>     "number": 1347,
+>     ...
+>   },
+>   "repository" : {
+>     "id": 1296269,
+>     "full_name": "octocat/Hello-World",
+>     "owner": {
+>       "login": "octocat",
+>       "id": 1,
+>       ...
+>     },
+>     ...
+>   },
+>   "sender": {
+>     "login": "octocat",
+>     "id": 1,
+>     ...
+>   }
+> }
 
    
+
    +
    +
    +
    +

    + branch_protection_configuration +

    +
    +
    +

    + This event occurs when there is a change to branch protection + configurations for a repository. For more information, see "About protected branches." For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository + permission. +

    +
    +

    + Availability for branch_protection_configuration +

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + branch_protection_configuration +

    +
    +
    + +
    +
    +
    +

    All branch protections were disabled for a repository.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: disabled +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - issue_comment -

    -

    - Activity related to an issue or pull request comment. The type of - activity is specified in the action property of the payload - object. For more information, see the "issue comments" REST API. -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Issues permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    issueobject - The - issue the - comment belongs to. -
    commentobject - The - comment +
    +

    + branch_protection_rule +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository + permission. +

    +
    +

    Availability for branch_protection_rule

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for branch_protection_rule +

    +
    +
    + +
    +
    +

    A branch protection rule was created.

    +
    + - itself. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + rule object + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + bypass_request_push_ruleset +

    +
    +
    +

    + This event occurs when there is activity related to a user's + request to bypass a set of push rules. +

    +

    + For more information, see "Managing requests to bypass push rulesets." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository + permission. +

    +

    + Note: Delegated bypass for push rules is currently in beta and + subject to change. +

    +
    +

    Availability for bypass_request_push_ruleset

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + bypass_request_push_ruleset +

    +
    +
    + +
    +
    +

    A push ruleset bypass request was cancelled.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: cancelled +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + exemption_request object + Required +
    +
    +
    +

    + A request from a user to be exempted from a set of + rules. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + bypass_request_secret_scanning +

    +
    +
    +

    + This event occurs when there is activity related to a user's + request to bypass secret scanning push protection. +

    +

    + For more information, see "Enabling delegated bypass for push protection." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Secret scanning alerts" repository + permission. +

    +

    + Note: Delegated bypass for push protection is currently in beta + and subject to change. +

    +
    +

    + Availability for bypass_request_secret_scanning +

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + bypass_request_secret_scanning +

    +
    +
    + +
    +
    +
    +

    + A secret scanning push protection bypass request was cancelled. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "id": 2,
-    "node_id": "MDEyOklzc3VlQ29tbWVudDI=",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:37:55Z",
-    "updated_at": "2019-05-15T19:37:55Z",
-    "author_association": "OWNER",
-    "body": "You are totally right! I'll get this fixed right away."
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: cancelled +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + exemption_request object + Required +
    +
    +
    +

    + A request from a user to be exempted from a set of + rules. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - issues -

    -

    - Activity related to an issue. The type of activity is specified in the - action property of the payload object. For more - information, see the "issues" REST API. -

    -

    - - Availability -

    -
      -
    • Repository webhooks
      • -
    • Organization webhooks
      • -
    • GitHub Apps with Issues permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of opened, - edited, deleted, pinned, - unpinned, closed, reopened, - assigned, unassigned, - labeled, unlabeled, locked, - unlocked, transferred, - milestoned, or demilestoned. -
    issueobject - The - issue - itself. -
    changesobject - The changes to the issue if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    assigneeobject - The optional user who was assigned or unassigned from the issue. -
    labelobject - The optional label that was added or removed from the issue. -
    repositoryobject - The - repository +
    +

    + check_run +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: The 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. +

    +
    +

    Availability for check_run

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for check_run

    +
    +
    + +
    +
    +
    +

    A check run was completed, and a conclusion is available.

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    action string
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    + check_run object + Required +
    +
    +
    +

    + A check performed on the code of a given code + change +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + check_suite +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: The 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. +

    +
    +

    Availability for check_suite

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for check_suite

    +
    +
    + +
    +
    +
    +

    + All check runs in a check suite have completed, and a conclusion + is available. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example when someone edits an issue -

    -
    - 
    {
-  "action": "edited",
-  "issue": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
-    "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
-    "id": 10,
-    "node_id": "MDU6SXNzdWUxMA==",
-    "number": 1,
-    "title": "Spelling error in the README file",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "labels": [
-      {
-        "id": 941,
-        "node_id": "MDU6TGFiZWw5NDE=",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
-        "name": "bug",
-        "color": "d73a4a",
-        "default": true
-      }
-    ],
-    "state": "open",
-    "locked": false,
-    "assignee": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "assignees": [
-      {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      }
-    ],
-    "milestone": {
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-      "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-      "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-      "id": 2,
-      "node_id": "MDk6TWlsZXN0b25lMg==",
-      "number": 1,
-      "title": "v1.0",
-      "description": "Add new space flight simulator",
-      "creator": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "open_issues": 1,
-      "closed_issues": 0,
-      "state": "closed",
-      "created_at": "2019-05-15T19:37:52Z",
-      "updated_at": "2019-05-15T19:37:53Z",
-      "due_on": "2019-05-23T00:00:00Z",
-      "closed_at": "2019-05-15T19:37:53Z"
-    },
-    "comments": 0,
-    "created_at": "2019-05-15T19:37:53Z",
-    "updated_at": "2019-05-15T19:37:54Z",
-    "closed_at": null,
-    "author_association": "OWNER",
-    "body": "It looks like you accidently spelled 'commit' with two 't's."
-  },
-  "changes": {},
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    + check_suite object + Required +
    +
    +
    +

    + The + check_suite. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    -

    - - label -

    -

    - Activity related to a label. The type of activity is specified in the - action property of the payload object. For more - information, see the "labels" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be created, - edited, or deleted. -
    labelobjectThe label that was added.
    changesobject - The changes to the label if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[color][from]string - The previous version of the color if the action was - edited. -
    repositoryobject - The - repository +
    +

    + code_scanning_alert +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Code scanning alerts" repository + permission. +

    +
    +

    Availability for code_scanning_alert

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for code_scanning_alert

    +
    +
    + +
    +
    +
    +

    + 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. +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: appeared_in_branch +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +

    + The code scanning alert involved in the event. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + commit_oid string + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + commit_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for commit_comment

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for commit_comment

    +

    Someone commented on a commit.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "label": {
-    "id": 965,
-    "node_id": "MDU6TGFiZWw5NjU=",
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix",
-    "name": ":bug: Bugfix",
-    "color": "cceeaa",
-    "default": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +

    + The action performed. Can be created. +

    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +

    + The + commit comment + resource. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - member -

    -

    - Activity related to repository collaborators. The type of activity is - specified in the action property of the payload object. For - more information, see the "collaborators" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: +
    +
    +

    + create +

    +
    +
    +

    This event occurs when a Git branch or tag is created.

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    +

    Notes:

    • - added - A user accepts an invitation to a - repository. -
      • -
    • - removed - A user is removed as a collaborator in - a repository. + This event will not occur when more than three tags are + created at once.
    • - edited - A user's collaborator permissions have - changed. + Payloads are capped at 25 MB. If an event generates a larger + payload, GitHub will not deliver a payload for that webhook + event. This may happen, for example, if many branches or tags + are pushed at once. We suggest monitoring your payload size to + ensure delivery.
    -
    memberobject - The - user that - was added. -
    changesobject - The changes to the collaborator permissions if the action was - edited. -
    changes[old_permission][from]string - The previous permissions of the collaborator if the action was - edited. -
    repositoryobject - The - repository +

    Availability for create

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for create

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + description string or null + Required +
    +
    +
    +

    The repository's current description.

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + master_branch string + Required +
    +
    +
    +

    + The name of the repository's default branch + (usually main). +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pusher_type string + Required +
    +
    +
    +

    + The pusher type for the event. Can be either + user or a deploy key. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + The + git ref + resource. +

    +
    +
    +
    +
    +
    +
    +
    + ref_type string + Required +
    +
    +
    +

    + The type of Git ref object created in the + repository. +

    +
    +
    +

    + Can be one of: tag, branch +

    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    + + + +
    +
    +

    + custom_property +

    +
    +
    +

    + This event occurs when there is activity relating to a custom + property. +

    +

    + For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Custom properties" organization + permission. +

    +
    +

    Availability for custom_property

    +
      +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for custom_property

    +
    +
    + +
    +
    +

    A new custom property was created.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added",
-  "member": {
-    "login": "Hacktocat",
-    "id": 5,
-    "node_id": "MDQ6VXNlcjU=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-    "html_url": "https://octocoders.github.io/Hacktocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + definition object + Required +
    +
    +
    +

    Custom property defined on an organization

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - membership -

    -

    - Activity related to team membership. The type of activity is specified - in the action property of the payload object. For more - information, see the "team members" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be added or - removed. -
    scopestring - The scope of the membership. Currently, can only be - team. -
    memberobject - The - user that - was added or removed. -
    teamobject - The - team for - the membership. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + custom_property_values +

    +
    +
    +

    + This event occurs when there is activity relating to custom + property values for a repository. +

    +

    + For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Custom properties" organization + permission. +

    +
    +

    Availability for custom_property_values

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for custom_property_values +

    +
    +

    The custom property values of a repository were updated.

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "removed",
-  "scope": "team",
-  "member": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: updated +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + new_property_values + array of objects Required +
    +
    +
    +

    + The new custom property values for the repository. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + old_property_values + array of objects Required +
    +
    +
    +

    + The old custom property values for the repository. +

    +
    +
    +
    +
    +
    +
    + +
    +
    + + + -

    - - meta -

    -

    - The webhook this event is configured on was deleted. This event will - only listen for changes to the particular hook the event is installed - on. Therefore, it must be selected for each hook that you'd like to - receive meta events for. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action performed. Can be deleted.
    hook_idintegerThe id of the modified webhook.
    hookobject - The modified webhook. This will contain different keys based on - the type of webhook it is: repository, organization, business, - app, or GitHub Marketplace. -
    repositoryobject - The - repository +
    +

    + delete +

    +
    +
    +

    + This event occurs when a Git branch or tag is deleted. To + subscribe to all pushes to a repository, including branch 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. +

    +

    + Note: This event will not occur when more than + three tags are deleted at once. +

    +
    +

    Availability for delete

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for delete

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pusher_type string + Required +
    +
    +
    +

    + The pusher type for the event. Can be either + user or a deploy key. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + The + git ref + resource. +

    +
    +
    +
    +
    +
    +
    +
    + ref_type string + Required +
    +
    +
    +

    + The type of Git ref object deleted in the + repository. +

    +
    +
    +

    + Can be one of: tag, branch +

    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + dependabot_alert +

    +
    +
    +

    + This event occurs when there is activity relating to Dependabot + alerts. +

    +

    + For 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Dependabot alerts" repository + permission. +

    +

    + Note: Webhook events for Dependabot alerts are + currently in beta and subject to change. +

    +
    +

    Availability for dependabot_alert

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for dependabot_alert

    +
    +
    + +
    +
    +
    +

    + A Dependabot alert was automatically closed by a Dependabot + auto-triage rule. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "deleted",
-  "hook_id": 101047067,
-  "hook": {
-    "type": "Repository",
-    "id": 101047067,
-    "name": "web",
-    "active": true,
-    "events": [
-      "meta"
-    ],
-    "config": {
-      "content_type": "json",
-      "insecure_ssl": "0",
-      "url": "http://example.com/hook"
-    },
-    "updated_at": "2019-04-10T03:57:12Z",
-    "created_at": "2019-04-10T03:57:12Z"
-  },
-  "repository": {
-    "id": 135493233,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "private": false,
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2018-05-30T20:18:04Z",
-    "updated_at": "2018-05-30T20:18:50Z",
-    "pushed_at": "2018-05-30T20:18:48Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 1,
-    "license": null,
-    "forks": 0,
-    "open_issues": 1,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: auto_dismissed +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +

    A Dependabot alert.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - milestone -

    -

    - Activity related to milestones. The type of activity is specified in the - action property of the payload object. For more - information, see the "milestones" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - closed, opened (a closed milestone is - re-opened), edited, or deleted. -
    milestoneobjectThe milestone itself.
    changesobject - The changes to the milestone if the action was - edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[due_on][from]string - The previous version of the due date if the action was - edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    repositoryobject - The - repository +
    +

    + deploy_key +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Deployments" repository permission. +

    +
    +

    Availability for deploy_key

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for deploy_key

    +
    +
    + +
    +
    +

    A deploy key was created.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + key object + Required +
    +
    +
    +

    + The + deploy key + resource. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + deployment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for deployment

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for deployment

    +

    A deployment was created.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "milestone": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
-    "id": 2,
-    "node_id": "MDk6TWlsZXN0b25lMg==",
-    "number": 1,
-    "title": "v1.0",
-    "description": "Add new space flight simulator",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "open_issues": 0,
-    "closed_issues": 0,
-    "state": "open",
-    "created_at": "2019-05-15T19:37:52Z",
-    "updated_at": "2019-05-15T19:37:52Z",
-    "due_on": "2019-05-23T00:00:00Z",
-    "closed_at": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:37:50Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + deployment object + Required +
    +
    +
    +

    + The + deployment. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    + + + -

    - - organization -

    -

    - Activity related to an organization and its members. The type of - activity is specified in the action property of the payload - object. For more information, see the "organizations" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: - created, deleted, renamed, - member_added, member_removed, or - member_invited. -
    invitationobject - The invitation for the user or email if the action is - member_invited. -
    membershipobject - The membership between the user and the organization. Not present - when the action is member_invited. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + deployment_protection_rule +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Deployments" repository permission. +

    +
    +

    Availability for deployment_protection_rule

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for deployment_protection_rule +

    +
    +

    + A deployment protection rule was requested for an environment. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "member_added",
-  "membership": {
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat",
-    "state": "active",
-    "role": "member",
-    "organization_url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "user": {
-      "login": "Hacktocat",
-      "id": 5,
-      "node_id": "MDQ6VXNlcjU=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/5?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
-      "html_url": "https://octocoders.github.io/Hacktocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
-      "type": "User",
-      "site_admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    action string
    +
    +
    +
    +

    + Value: requested +

    +
    +
    +
    +
    +
    +
    environment string
    +
    +
    +

    + The name of the environment that has the + deployment protection rule. +

    +
    +
    +
    +
    +
    +
    +
    event string
    +
    +
    +

    + The event that triggered the deployment protection + rule. +

    +
    +
    +
    +
    +
    +
    +
    + deployment_callback_url + string +
    +
    +
    +

    + The URL to review the deployment protection rule. +

    +
    +
    +
    +
    +
    +
    +
    deployment object
    +
    +
    +

    + A request for a specific ref(branch,sha,tag) to be + deployed +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + pull_requests + array of objects +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - package -

    -

    - Activity related to GitHub Packages. The type of activity is specified - in the action property of the payload object. For more - information, see "Managing packages with GitHub Packages" to learn more about GitHub Packages. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be published or - updated. -
    packageobjectInformation about the package.
    repositoryobject - The - repository +
    +

    + deployment_review +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for deployment_review

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for deployment_review

    +
    +
    + +
    +
    +

    A deployment review was approved.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: approved +

    +
    +
    +
    +
    +
    +
    approver object
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    comment string
    +
    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + reviewers array of objects +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + since string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + workflow_job_run object +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_job_runs + array of objects +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    +

    + deployment_status +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for deployment_status

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for deployment_status

    +

    A new deployment status was created.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "package": {
-    "id": 10696,
-    "name": "hello-world-npm",
-    "namespace": "Codertocat/hello-world-npm",
-    "description": null,
-    "ecosystem": "docker",
-    "package_type": "npm",
-    "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696",
-    "created_at": "2019-05-09T23:28:29Z",
-    "updated_at": "2019-05-09T23:28:29Z",
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "package_version": {
-      "id": 24147,
-      "version": "1.0.0",
-      "summary": "A simple npm package to demonstrate GitHub Packages",
-      "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498",
-      "description": "",
-      "body": "# hello-world-npm\n\nThis is a simple npm package that demonstrates the [Github Packages](https://github.com/features/package).\n\n## Installation \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n",
-      "body_html": "<h1>hello-world-npm</h1>\n<p>This is a simple npm package that demonstrates the <a href=\"https://github.com/features/package\">Github Package Registry</a>.</p>\n<h2>Installation</h2>\n<p><code>$ npm install</code></p>\n<h2>Usage</h2>\n<pre><code>const myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n</code></pre>",
-      "release": {
-        "url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286",
-        "html_url": "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0",
-        "id": 17264286,
-        "tag_name": "1.0.0",
-        "target_commitish": "master",
-        "name": "1.0.0",
-        "draft": false,
-        "author": {
-          "login": "Codertocat",
-          "id": 21031067,
-          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/Codertocat",
-          "html_url": "https://github.com/Codertocat",
-          "followers_url": "https://api.github.com/users/Codertocat/followers",
-          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-          "repos_url": "https://api.github.com/users/Codertocat/repos",
-          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "prerelease": false,
-        "created_at": "2019-05-09T23:24:40Z",
-        "published_at": "2019-05-09T23:26:59Z"
-      },
-      "manifest": "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A simple npm package to demonstrate GitHub Package Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo \\\"Error: no test specified\\\" \\u0026\\u0026 exit 1\"},\"version\":\"1.0.0\"}",
-      "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0",
-      "tag_name": "1.0.0",
-      "target_commitish": "master",
-      "target_oid": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b",
-      "draft": false,
-      "prerelease": false,
-      "created_at": "2019-05-09T23:28:29Z",
-      "updated_at": "2019-05-09T23:28:30Z",
-      "metadata": [],
-      "docker_metadata": [],
-      "package_files": [
-        {
-          "download_url": "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream",
-          "id": 92167,
-          "name": "hello-world-npm-1.0.0-npm.tgz",
-          "sha256": "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8",
-          "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb",
-          "md5": "56ebbd5a5a03367f62d0c732bafd3c66",
-          "content_type": "application/octet-stream",
-          "state": "uploaded",
-          "size": 654,
-          "created_at": "2019-05-09T23:28:30Z",
-          "updated_at": "2019-05-09T23:28:30Z"
-        }
-      ],
-      "author": {
-        "login": "Codertocat",
-        "id": 21031067,
-        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/Codertocat",
-        "html_url": "https://github.com/Codertocat",
-        "followers_url": "https://api.github.com/users/Codertocat/followers",
-        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-        "repos_url": "https://api.github.com/users/Codertocat/repos",
-        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "source_url": "ghcr.io/Codertocat/hello-world-npm/image-1:v1",
-      "installation_command": "npm install @Codertocat/@1.0.0"
-    },
-    "registry": {
-      "about_url": "https://help.github.com/about-github-packages",
-      "name": "GitHub npm registry",
-      "type": "npm",
-      "url": "https://npm.pkg.github.com/@Codertocat",
-      "vendor": "GitHub Inc"
-    }
-  },
-  "repository": {
-    "id": 185882436,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=",
-    "name": "hello-world-npm",
-    "full_name": "Codertocat/hello-world-npm",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/hello-world-npm",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world-npm",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments",
-    "created_at": "2019-05-09T22:53:26Z",
-    "updated_at": "2019-05-09T23:24:42Z",
-    "pushed_at": "2019-05-09T23:27:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world-npm.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world-npm.git",
-    "clone_url": "https://github.com/Codertocat/hello-world-npm.git",
-    "svn_url": "https://github.com/Codertocat/hello-world-npm",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + check_run object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + deployment object + Required +
    +
    +
    +

    + The + deployment. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + deployment_status object + Required +
    +
    +
    +

    + The + deployment status. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    + + + -

    - - page_build -

    -

    - Represents an attempted build of a GitHub Pages site, whether successful - or not. A push to a GitHub Pages enabled branch (gh-pages - for project pages, the default branch for user and organization pages) - triggers this event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    idintegerThe unique identifier of the page build.
    buildobject - The - List GitHub Pages builds +
    +

    + discussion +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for GitHub Discussions are + currently in beta and subject to change. +

    +
    +

    Availability for discussion

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for discussion

    +
    +
    + +
    +
    +
    +

    A comment on the discussion was marked as the answer.

    +
    +
    + - itself. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: answered +

    +
    +
    +
    +
    +
    +
    + answer object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + discussion object + Required +
    +
    +

    A Discussion in a repository.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + discussion_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for GitHub Discussions are + currently in beta and subject to change. +

    +
    +

    Availability for discussion_comment

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for discussion_comment

    +
    +
    + +
    +
    +

    A comment on a discussion was created.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + discussion object + Required +
    +
    +

    A Discussion in a repository.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + fork +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    +
    +

    Availability for fork

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for fork

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 7,
-  "build": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7",
-    "status": "built",
-    "error": {
-      "message": null
-    },
-    "pusher": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "commit": "3648135c2986115284ae152d90459473b15fd19c",
-    "duration": 6917,
-    "created_at": "2019-05-15T19:38:15Z",
-    "updated_at": "2019-05-15T19:38:22Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + forkee object + Required +
    +
    +
    +

    + The created + repository + resource. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - ping -

    -

    - When you create a new webhook, we'll send you a simple - ping event to let you know you've set up the webhook - correctly. This event isn't stored so it isn't retrievable via the - Events API - endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    zenstringRandom string of GitHub zen.
    hook_idintegerThe ID of the webhook that triggered the ping.
    hookobject - The - webhook configuration. -
    hook[app_id]integer - When you register a new GitHub App, GitHub AE sends a ping event - to the webhook URL you specified during - registration. The event contains the app_id, which is - required for - authenticating +
    +

    + github_app_authorization +

    +
    +
    +

    + 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. +

    +

    + A GitHub App receives this webhook by default and cannot + unsubscribe from this event. +

    +

    + Anyone 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." +

    +
    +

    Availability for github_app_authorization

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for github_app_authorization +

    +
    +

    Someone revoked their authorization of a GitHub App.

    +
    +
    + - an app. - - - - - - + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: revoked +

    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + gollum +

    +
    +
    +

    + This event occurs when someone creates or updates a wiki page. + For more information, see "About wikis." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    +
    +

    Availability for gollum

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for gollum

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pages array of objects + Required +
    +
    +

    The pages that were updated.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + installation +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for installation

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for installation

    +
    +
    + +
    +
    +
    +

    + Someone installed a GitHub App on a user or organization + account. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "zen": "Non-blocking is better than blocking.",
-  "hook_id": 30,
-  "hook": {
-    "type": "Repository",
-    "id": 30,
-    "name": "web",
-    "active": true,
-    "events": [
-      "*"
-    ],
-    "config": {
-      "content_type": "json",
-      "url": "https://smee.io/YEbF2t8kjvPAn7Ck",
-      "insecure_ssl": "0"
-    },
-    "updated_at": "2019-05-15T19:38:17Z",
-    "created_at": "2019-05-15T19:38:17Z",
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30",
-    "test_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test",
-    "ping_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings",
-    "last_response": {
-      "code": null,
-      "status": "unused",
-      "message": null
-    }
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +

    Installation

    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repositories + array of objects +
    +
    +
    +

    + An array of repository objects that the + installation can access. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + requester object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - project -

    -

    - Activity related to project boards. The type of activity is specified in - the action property of the payload object. For more - information, see the "projects" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed on the project. Can be one of - created, edited, closed, - reopened, or deleted. -
    changesobject - The changes to the project if the action was edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    projectobject - The - project - itself. -
    repositoryobject - The - repository +
    +

    + installation_repositories +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for installation_repositories

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for installation_repositories +

    +
    +
    + +
    +
    +
    +

    + A GitHub App installation was granted access to one or more + repositories. +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +

    Installation

    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repositories_added + array of objects Required +
    +
    +
    +

    + An array of repository objects, which were added + to the installation. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repositories_removed + array of objects Required +
    +
    +
    +

    + An array of repository objects, which were removed + from the installation. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + repository_selection string + Required +
    +
    +
    +

    + Describe whether all repositories have been + selected or there's a selection involved +

    +
    +
    +

    + Can be one of: all, selected +

    +
    +
    +
    +
    +
    +
    + requester object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + installation_target +

    +
    +
    +

    + 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. +

    +
    +

    Availability for installation_target

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for installation_target

    +
    +

    + Somebody renamed the user or organization account that a GitHub + App is installed on. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project": {
-    "owner_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "url": "https://octocoders.github.io/api/v3/projects/6",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/projects/1",
-    "columns_url": "https://octocoders.github.io/api/v3/projects/6/columns",
-    "id": 6,
-    "node_id": "MDc6UHJvamVjdDY=",
-    "name": "Space 2.0",
-    "body": "Project tasks for a trip to Space",
-    "number": 1,
-    "state": "open",
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:38:27Z",
-    "updated_at": "2019-05-15T19:38:27Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + account object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: renamed +

    +
    +
    +
    +
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + target_type string + Required +
    +
    +
    +
    +
    +
    +
    + + + -

    - - project_card -

    -

    - Activity related to cards in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project cards" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed on the project card. Can be - created, edited, moved, - converted, or deleted. -
    changesobject - The changes to the project card if the action was - edited or converted. -
    changes[note][from]string - The previous version of the note if the action was - edited or converted. -
    after_idinteger - The id of the card that this card now follows if the action was - "moved". Will be null if it is the first card in a - column. -
    project_cardobject - The - project card +
    +

    + issue_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for issue_comment

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for issue_comment

    +
    +
    + +
    +
    +

    A comment on an issue or pull request was created.

    +
    + - itself. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +

    + The + comment + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + issue object + Required +
    +
    +
    +

    + The + issue + the comment belongs to. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + issues +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for issues

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for issues

    +
    +
    + +
    +
    +

    An issue was assigned to a user.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +

    The action that was performed.

    +
    +

    + Value: assigned +

    +
    +
    +
    +
    +
    +
    + assignee object or null +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + issue object + Required +
    +
    +
    +

    + The + issue + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + label +

    +
    +
    +

    + 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. +

    +

    + If 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. +

    +
    +

    Availability for label

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for label

    +
    +
    + +
    +
    +

    A label was created.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_card": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/cards/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "column_url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "column_id": 8,
-    "id": 8,
-    "node_id": "MDExOlByb2plY3RDYXJkOA==",
-    "note": "Work that can be completed in one hour or less.",
-    "archived": false,
-    "creator": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + label object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - project_column -

    -

    - Activity related to columns in a project board. The type of activity is - specified in the action property of the payload object. For - more information, see the "project columns" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed on the project column. Can be one of - created, edited, moved or - deleted. -
    changesobject - The changes to the project column if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    after_idinteger - The id of the column that this column now follows if the action - was "moved". Will be null if it is the first column - in a project. -
    project_columnobject - The - project column +
    +

    + marketplace_purchase +

    +
    +
    +

    + This event occurs when there is activity relating to a GitHub + Marketplace purchase. For more information, see "GitHub Marketplace." For information about the APIs to manage GitHub Marketplace + listings, see + the GraphQL documentation + or "GitHub Marketplace" in the REST API documentation. +

    +
    +

    Availability for marketplace_purchase

    +
      +
    • GitHub Marketplace
      • +
    +

    + Webhook payload object for marketplace_purchase +

    +
    +
    + +
    +
    +
    +

    + Someone cancelled a GitHub Marketplace plan, and the last + billing cycle has ended. The change will take effect on the + account immediately. +

    +
    +
    + - itself. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: cancelled +

    +
    +
    +
    +
    +
    +
    + effective_date string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + marketplace_purchase object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + previous_marketplace_purchase + object +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + member +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Members" organization permission. +

    +
    +

    Availability for member

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for member

    +
    +
    + +
    +
    +
    +

    A GitHub user accepted an invitation to a repository.

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added +

    +
    +
    +
    +
    +
    +
    changes object
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + member object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + membership +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Members" organization permission. +

    +
    +

    Availability for membership

    +
      +
    • Organizations
      • +
    • Enterprises
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for membership

    +
    +
    + +
    +
    +

    An organization member was added to a team.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "project_column": {
-    "url": "https://octocoders.github.io/api/v3/projects/columns/8",
-    "project_url": "https://octocoders.github.io/api/v3/projects/6",
-    "cards_url": "https://octocoders.github.io/api/v3/projects/columns/8/cards",
-    "id": 8,
-    "node_id": "MDEzOlByb2plY3RDb2x1bW44",
-    "name": "Small bugfixes",
-    "created_at": "2019-05-15T19:39:01Z",
-    "updated_at": "2019-05-15T19:39:01Z"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:27Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + member object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + scope string + Required +
    +
    +
    +

    + The scope of the membership. Currently, can only + be team. +

    +
    +
    +

    + Value: team +

    +
    +
    +
    +
    +
    +
    + sender object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + team object + Required +
    +
    +
    +

    + Groups of organization members that gives + permissions on specified repositories. +

    +
    +
    +
    +
    +
    +
    + +
    +
    + + + -

    - - public -

    -

    - When a private repository is made public. Without a doubt: the best - GitHub AE event. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    repositoryobject - The - repository +
    +

    + merge_group +

    +
    +
    +

    + This event occurs when there is activity relating to a merge + group in a merge queue. For more information, see "Managing a merge queue." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Merge queues" repository permission. +

    +
    +

    Availability for merge_group

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for merge_group

    +
    +
    + +
    +
    +
    +

    + Status checks were requested for a merge group. This happens + when a merge group is created or added to by the merge queue + because a pull request was queued. +

    +

    + When you receive this event, you should perform checks on the + head SHA and report status back using check runs or commit + statuses. +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: checks_requested +

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + merge_group object + Required +
    +
    +
    +

    + A group of pull requests that the merge queue has + grouped together to be merged. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + meta +

    +
    +
    +

    + This event occurs when there is activity relating to a webhook + itself. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Meta" app permission. +

    +
    +

    Availability for meta

    +
      +
    • GitHub Marketplace
      • +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for meta

    +

    The webhook was deleted.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: deleted +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + hook object + Required +
    +
    +
    +

    + The modified webhook. This will contain different + keys based on the type of webhook it is: + repository, organization, business, app, or GitHub + Marketplace. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + hook_id integer + Required +
    +
    +

    The id of the modified webhook.

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - pull_request -

    -

    - Activity related to pull requests. The type of activity is specified in - the action property of the payload object. For more - information, see the "pull requests" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • assigned
      • -
    • auto_merge_disabled
      • -
    • auto_merge_enabled
      • -
    • - closed: If the action is closed and - the merged key is false, the pull - request was closed with unmerged commits. If the action is - closed and the merged key is - true, the pull request was merged. -
      • -
    • converted_to_draft
      • -
    • edited
      • -
    • labeled
      • -
    • locked
      • -
    • opened
      • -
    • ready_for_review
      • -
    • reopened
      • -
    • review_request_removed
      • -
    • review_requested
      • -
    • - synchronize: Triggered when a pull request's head - branch is updated. For example, when the head branch is - updated from the base branch, when new commits are pushed to - the head branch, or when the base branch is changed. -
      • -
    • unassigned
      • -
    • unlabeled
      • -
    • unlocked
      • -
    -
    numberintegerThe pull request number.
    changesobject - The changes to the comment if the action was edited. -
    changes[title][from]string - The previous version of the title if the action was - edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request +
    +

    + milestone +

    +
    +
    +

    + 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. +

    +

    + If 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. +

    +
    +

    Availability for milestone

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for milestone

    +
    +
    + +
    +
    +

    A milestone was closed.

    +
    + - itself. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: closed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + milestone object + Required +
    +
    +
    +

    + A collection of related issues and pull requests. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + org_block +

    +
    +
    +

    + This event occurs when organization owners or moderators block + or unblock a non-member from collaborating on the organization's + repositories. For more information, see "Blocking a user from your organization." For information about the APIs to manage blocked users, see + the GraphQL documentation + or "Blocking users" in the REST API documentation. +

    +

    + If you want to receive an event when members are added or + removed from an organization, use the + organization event instead. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" organization + permission. +

    +
    +

    Availability for org_block

    +
      +
    • Organizations
      • +
    • Enterprises
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for org_block

    +
    +
    + +
    +
    +

    A user was blocked from the organization.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: blocked +

    +
    +
    +
    +
    +
    +
    + blocked_user object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + organization +

    +
    +
    +

    + 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. +

    +

    + If 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. +

    +
    +

    Availability for organization

    +
      +
    • Organizations
      • +
    • Enterprises
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for organization

    +
    +
    + +
    +
    +

    An organization was deleted.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -

    - Deliveries for review_requested and - review_request_removed events will have an additional field - called requested_reviewer. -

    -
    - 
    {
-  "action": "opened",
-  "number": 2,
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:02Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": null,
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER",
-    "draft": false,
-    "merged": false,
-    "mergeable": null,
-    "rebaseable": null,
-    "mergeable_state": "unknown",
-    "merged_by": null,
-    "comments": 0,
-    "review_comments": 0,
-    "maintainer_can_modify": false,
-    "commits": 1,
-    "additions": 1,
-    "deletions": 1,
-    "changed_files": 1
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: deleted +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    membership object
    +
    +
    +

    + The membership between the user and the + organization. Not present when the action is + member_invited. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - pull_request_review -

    -

    - Activity related to pull request reviews. The type of activity is - specified in the action property of the payload object. For - more information, see the "pull request reviews" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - submitted - A pull request review is submitted - into a non-pending state. -
      • -
    • - edited - The body of a review has been edited. -
      • -
    • dismissed - A review has been dismissed.
      • -
    -
    pull_requestobject - The - pull request +
    +

    + package +

    +
    +
    +

    + 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. +

    +

    + To install this event on a GitHub App, the app must have at + least read-level access for the "Packages" repository + permission. +

    +
    +

    Availability for package

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for package

    +
    +
    + +
    +
    +

    A package was published to a registry.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + package object + Required +
    +
    +

    Information about the package.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + page_build +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Pages" repository permission. +

    +
    +

    Availability for page_build

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for page_build

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + build object + Required +
    +
    +
    +

    + The + List GitHub Pages builds + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + id integer + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + personal_access_token_request +

    +
    +
    +

    + 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." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Personal access token requests" + organization permission. +

    +

    + Note: Fine-grained PATs are in public beta. + Related APIs, events, and functionality are subject to change. +

    +
    +

    Availability for personal_access_token_request

    +
      +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + personal_access_token_request +

    +
    +
    + +
    +
    +
    +

    A fine-grained personal access token request was approved.

    +
    +
    + - the review pertains to. - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    reviewobjectThe review that was affected.
    changes[body][from]string - The previous version of the body if the action was - edited. -
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: approved +

    +
    +
    +
    +
    +
    +
    + personal_access_token_request + object Required +
    +
    +
    +

    Details of a Personal Access Token Request.

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + ping +

    +
    +
    +

    + This event occurs when you create a new webhook. The ping event + is a confirmation from GitHub that you configured the webhook + correctly. +

    +
    +

    Availability for ping

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    • Enterprises
      • +
    • GitHub Marketplace
      • +
    +

    Webhook payload object for ping

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    hook object
    +
    +

    The webhook that is being pinged

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    hook_id integer
    +
    +
    +

    + The ID of the webhook that triggered the ping. +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    zen string
    +
    +

    Random string of GitHub zen.

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + project_card +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for project_card

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for project_card

    +
    +
    + +
    +
    +
    +

    A note in a project (classic) was converted to an issue.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: converted +

    +
    +
    +
    +
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + project_card object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + project +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for project

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for project

    +
    +
    + +
    +
    +

    A project (classic) was closed.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: closed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + project object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + project_column +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for project_column

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for project_column

    +
    +
    + +
    +
    +

    A column was added to a project (classic).

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "submitted",
-  "review": {
-    "id": 2,
-    "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": null,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "submitted_at": "2019-05-15T19:38:08Z",
-    "state": "commented",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + project_column object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - pull_request_review_comment -

    -

    - Activity related to pull request review comments in the pull request's - unified diff. The type of activity is specified in the - action property of the payload object. For more - information, see the "pull request review comments" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed on the comment. Can be one of - created, edited, or - deleted. -
    changesobject - The changes to the comment if the action was edited. -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    pull_requestobject - The - pull request +
    +

    + projects_v2 +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for projects are currently + in beta and subject to change. To share feedback about projects + webhooks with GitHub, see the + Projects webhook feedback discussion. +

    +
    +

    Availability for projects_v2

    +
      +
    • Organizations
      • +
    +

    Webhook payload object for projects_v2

    +
    +
    + +
    +
    +

    A project in the organization was closed.

    +
    + - the comment belongs to. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
    commentobject - The - comment + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: closed +

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + projects_v2 object + Required +
    +
    +

    A projects v2 project

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + projects_v2_item +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +

    + Note: Webhook events for projects are currently + in beta and subject to change. To share feedback about projects + webhooks with GitHub, see the + Projects webhook feedback discussion. +

    +
    +

    Availability for projects_v2_item

    +
      +
    • Organizations
      • +
    +

    Webhook payload object for projects_v2_item

    +
    +
    + +
    +
    +
    +

    + An item on an organization project was archived. For more + information, see "Archiving items from your project." +

    +
    +
    + - itself. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: archived +

    +
    +
    +
    +
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + projects_v2_item object + Required +
    +
    +

    An item belonging to a project

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + projects_v2_status_update +

    +
    +
    +

    + This event occurs when there is activity relating to a status + update on an organization-level project. For more information, + see "About Projects." +

    +

    + For activity relating to a project, use the + projects_v2 event. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Projects" organization permission. +

    +

    + Note: To share feedback about projects webhooks + with GitHub, see the + Projects webhook feedback discussion. +

    +
    +

    Availability for projects_v2_status_update

    +
      +
    • Organizations
      • +
    +

    + Webhook payload object for projects_v2_status_update +

    +
    +
    + +
    +
    +
    +

    A status update was added to a project in the organization.

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + projects_v2_status_update + object Required +
    +
    +
    +

    An status update belonging to a project

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + public +

    +
    +
    +

    + This event occurs when repository visibility changes from + private to public. For more information, see "Setting repository visibility." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    +
    +

    Availability for public

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for public

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "comment": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2",
-    "pull_request_review_id": 2,
-    "id": 2,
-    "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=",
-    "diff_hunk": "@@ -1 +1 @@\n-# Hello-World",
-    "path": "README.md",
-    "position": 1,
-    "original_position": 1,
-    "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "original_commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "Maybe you should use more emoji on this line.",
-    "created_at": "2019-05-15T19:38:07Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2",
-    "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "author_association": "OWNER",
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2"
-      },
-      "pull_request": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      }
-    }
-  },
-  "pull_request": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
-    "id": 2,
-    "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
-    "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
-    "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
-    "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
-    "number": 2,
-    "state": "open",
-    "locked": false,
-    "title": "Update the README with new information.",
-    "user": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "body": "This is a pretty simple change that we need to pull into master.",
-    "created_at": "2019-05-15T19:38:02Z",
-    "updated_at": "2019-05-15T19:38:08Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
-    "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
-    "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
-    "head": {
-      "label": "Codertocat:changes",
-      "ref": "changes",
-      "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "Codertocat:master",
-      "ref": "master",
-      "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-      "user": {
-        "login": "Codertocat",
-        "id": 4,
-        "node_id": "MDQ6VXNlcjQ=",
-        "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-        "gravatar_id": "",
-        "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-        "html_url": "https://octocoders.github.io/Codertocat",
-        "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-        "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-        "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-        "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-        "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-        "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-        "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-        "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-        "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-        "type": "User",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 118,
-        "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-        "name": "Hello-World",
-        "full_name": "Codertocat/Hello-World",
-        "private": false,
-        "owner": {
-          "login": "Codertocat",
-          "id": 4,
-          "node_id": "MDQ6VXNlcjQ=",
-          "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-          "gravatar_id": "",
-          "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-          "html_url": "https://octocoders.github.io/Codertocat",
-          "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-          "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-          "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-          "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-          "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-          "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-          "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-          "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-          "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "description": null,
-        "fork": false,
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-        "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-        "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-        "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-        "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-        "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-        "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-        "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-        "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-        "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-        "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-        "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-        "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-        "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-        "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-        "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-        "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-        "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-        "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-        "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-        "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-        "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-        "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-        "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-        "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-        "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-        "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-        "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-        "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-        "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-        "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-        "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-        "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-        "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-        "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-        "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-        "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-        "created_at": "2019-05-15T19:37:07Z",
-        "updated_at": "2019-05-15T19:37:10Z",
-        "pushed_at": "2019-05-15T19:38:03Z",
-        "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-        "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-        "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-        "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-        "homepage": null,
-        "size": 0,
-        "stargazers_count": 0,
-        "watchers_count": 0,
-        "language": null,
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": true,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 2,
-        "license": null,
-        "forks": 0,
-        "open_issues": 2,
-        "watchers": 0,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
-      },
-      "html": {
-        "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
-      },
-      "issue": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
-      },
-      "comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
-      },
-      "review_comments": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
-      },
-      "review_comment": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
-      },
-      "statuses": {
-        "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
-      }
-    },
-    "author_association": "OWNER"
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:37:10Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - pull_request_review_thread -

    -

    - Activity related to a comment thread on a pull request being marked as - resolved or unresolved. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - resolved - A comment thread on a pull request was - marked as resolved. -
      • -
    • - unresolved - A previously resolved comment thread - on a pull request was marked as unresolved. -
      • -
    -
    pull_requestobject - The - pull request +
    +

    + pull_request +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for pull_request

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for pull_request

    +
    +
    + +
    +
    +

    A pull request was assigned to a user.

    +
    + - the thread pertains to. - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    threadobjectThe thread that was affected.
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: assigned +

    +
    +
    +
    +
    +
    +
    + assignee object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + number integer + Required +
    +
    +

    The pull request number.

    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + pull_request_review_comment +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for pull_request_review_comment

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + pull_request_review_comment +

    +
    +
    + +
    +
    +

    A comment on a pull request diff was created.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + comment object + Required +
    +
    +
    +

    + The + comment + itself. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + pull_request_review +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for pull_request_review

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for pull_request_review

    +
    +
    + +
    +
    +

    A review on a pull request was dismissed.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "resolved",
-  "pull_request": {
-    "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-    "id": 873298238,
-    "node_id": "PR_kwDOEL39TM40DXk-",
-    "html_url": "https://github.com/octo-org/octo-repo/pull/118",
-    "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff",
-    "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch",
-    "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118",
-    "number": 118,
-    "state": "open",
-    "locked": false,
-    "title": "Create issue-comment",
-    "user": {
-      "login": "octocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octocat",
-      "html_url": "https://github.com/octocat",
-      "followers_url": "https://api.github.com/users/octocat/followers",
-      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/octocat/orgs",
-      "repos_url": "https://api.github.com/users/octocat/repos",
-      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "body": "Issue comment test",
-    "created_at": "2022-03-07T16:14:34Z",
-    "updated_at": "2022-03-21T09:21:38Z",
-    "closed_at": null,
-    "merged_at": null,
-    "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1",
-    "assignee": null,
-    "assignees": [],
-    "requested_reviewers": [],
-    "requested_teams": [],
-    "labels": [],
-    "milestone": null,
-    "draft": false,
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits",
-    "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments",
-    "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-    "head": {
-      "label": "octo-org:issue-comment",
-      "ref": "issue-comment",
-      "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "base": {
-      "label": "octo-org:master",
-      "ref": "master",
-      "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca",
-      "user": {
-        "login": "octo-org",
-        "id": 67584941,
-        "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-        "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-        "gravatar_id": "",
-        "url": "https://api.github.com/users/octo-org",
-        "html_url": "https://github.com/octo-org",
-        "followers_url": "https://api.github.com/users/octo-org/followers",
-        "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-        "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-        "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-        "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-        "organizations_url": "https://api.github.com/users/octo-org/orgs",
-        "repos_url": "https://api.github.com/users/octo-org/repos",
-        "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-        "received_events_url": "https://api.github.com/users/octo-org/received_events",
-        "type": "Organization",
-        "site_admin": false
-      },
-      "repo": {
-        "id": 280886604,
-        "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-        "name": "octo-repo",
-        "full_name": "octo-org/octo-repo",
-        "private": true,
-        "owner": {
-          "login": "octo-org",
-          "id": 67584941,
-          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-          "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/octo-org",
-          "html_url": "https://github.com/octo-org",
-          "followers_url": "https://api.github.com/users/octo-org/followers",
-          "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-          "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-          "organizations_url": "https://api.github.com/users/octo-org/orgs",
-          "repos_url": "https://api.github.com/users/octo-org/repos",
-          "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/octo-org/received_events",
-          "type": "Organization",
-          "site_admin": false
-        },
-        "html_url": "https://github.com/octo-org/octo-repo",
-        "description": "Change description",
-        "fork": false,
-        "url": "https://api.github.com/repos/octo-org/octo-repo",
-        "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-        "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-        "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-        "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-        "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-        "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-        "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-        "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-        "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-        "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-        "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-        "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-        "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-        "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-        "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-        "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-        "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-        "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-        "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-        "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-        "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-        "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-        "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-        "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-        "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-        "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-        "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-        "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-        "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-        "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-        "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-        "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-        "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-        "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-        "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-        "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-        "created_at": "2020-07-19T14:48:35Z",
-        "updated_at": "2022-03-11T11:56:22Z",
-        "pushed_at": "2022-04-01T09:37:36Z",
-        "git_url": "git://github.com/octo-org/octo-repo.git",
-        "ssh_url": "git@github.com:octo-org/octo-repo.git",
-        "clone_url": "https://github.com/octo-org/octo-repo.git",
-        "svn_url": "https://github.com/octo-org/octo-repo",
-        "homepage": "",
-        "size": 646,
-        "stargazers_count": 1,
-        "watchers_count": 1,
-        "language": "Ruby",
-        "has_issues": true,
-        "has_projects": true,
-        "has_downloads": true,
-        "has_wiki": true,
-        "has_pages": false,
-        "forks_count": 0,
-        "mirror_url": null,
-        "archived": false,
-        "disabled": false,
-        "open_issues_count": 60,
-        "license": null,
-        "allow_forking": false,
-        "is_template": false,
-        "topics": [
-          "hey",
-          "topic"
-        ],
-        "visibility": "private",
-        "forks": 0,
-        "open_issues": 60,
-        "watchers": 1,
-        "default_branch": "master"
-      }
-    },
-    "_links": {
-      "self": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-      },
-      "html": {
-        "href": "https://github.com/octo-org/octo-repo/pull/118"
-      },
-      "issue": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118"
-      },
-      "comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments"
-      },
-      "review_comments": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments"
-      },
-      "review_comment": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}"
-      },
-      "commits": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits"
-      },
-      "statuses": {
-        "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf"
-      }
-    },
-    "author_association": "CONTRIBUTOR",
-    "auto_merge": null,
-    "active_lock_reason": null
-  },
-  "thread": {
-    "node_id": "PRRT_kwDOEL39TM4w7XDQ",
-    "comments": [
-      {
-        "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280",
-        "pull_request_review_id": 901921390,
-        "id": 820867280,
-        "node_id": "PRRC_kwDOEL39TM4w7XDQ",
-        "diff_hunk": "@@ -0,0 +1 @@\n+issue comment",
-        "path": "issue-comment",
-        "position": 1,
-        "original_position": 1,
-        "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf",
-        "user": {
-          "login": "jide2020",
-          "id": 64502150,
-          "node_id": "MDQ6VXNlcjY0NTAyMTUw",
-          "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4",
-          "gravatar_id": "",
-          "url": "https://api.github.com/users/jide2020",
-          "html_url": "https://github.com/jide2020",
-          "followers_url": "https://api.github.com/users/jide2020/followers",
-          "following_url": "https://api.github.com/users/jide2020/following{/other_user}",
-          "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}",
-          "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}",
-          "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions",
-          "organizations_url": "https://api.github.com/users/jide2020/orgs",
-          "repos_url": "https://api.github.com/users/jide2020/repos",
-          "events_url": "https://api.github.com/users/jide2020/events{/privacy}",
-          "received_events_url": "https://api.github.com/users/jide2020/received_events",
-          "type": "User",
-          "site_admin": false
-        },
-        "body": "sup",
-        "created_at": "2022-03-07T16:16:48Z",
-        "updated_at": "2022-03-07T16:16:58Z",
-        "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280",
-        "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118",
-        "author_association": "COLLABORATOR",
-        "_links": {
-          "self": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280"
-          },
-          "html": {
-            "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280"
-          },
-          "pull_request": {
-            "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118"
-          }
-        },
-        "reactions": {
-          "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions",
-          "total_count": 0,
-          "+1": 0,
-          "-1": 0,
-          "laugh": 0,
-          "hooray": 0,
-          "confused": 0,
-          "heart": 0,
-          "rocket": 0,
-          "eyes": 0
-        },
-        "start_line": null,
-        "original_start_line": null,
-        "start_side": null,
-        "line": 1,
-        "original_line": 1,
-        "side": "RIGHT"
-      }
-    ]
-  },
-  "repository": {
-    "id": 280886604,
-    "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 67584941,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-      "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "Change description",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2020-07-19T14:48:35Z",
-    "updated_at": "2022-03-11T11:56:22Z",
-    "pushed_at": "2022-04-01T09:37:36Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 646,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 60,
-    "license": null,
-    "allow_forking": false,
-    "is_template": false,
-    "topics": [
-      "hey",
-      "topic"
-    ],
-    "visibility": "private",
-    "forks": 0,
-    "open_issues": 60,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 67584941,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4",
-    "description": ""
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: dismissed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + review object + Required +
    +
    +

    The review that was affected.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - push -

    -

    One or more commits are pushed to a repository branch or tag.

    -

    - Note: You will not receive a webhook for this event - when you push more than three tags at once. -

    +
    +

    + pull_request_review_thread +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for pull_request_review_thread

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for pull_request_review_thread +

    +
    +
    + +
    +
    +
    +

    A comment thread on a pull request was marked as resolved.

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: resolved +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pull_request object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + thread object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    refstring - The full - git ref +
    +

    + push +

    +
    +
    +

    + 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, when a branch is deleted, when a tag is deleted, or when + a repository is created from a template. To subscribe to only + branch and 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. +

    +

    + Note: Events 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. +

    +
    +

    Availability for push

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for push

    +
    +
    + - that was pushed. Example: refs/heads/main or - refs/tags/v3.14.1. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    beforestring - The SHA of the most recent commit on ref before the - push. -
    afterstring - The SHA of the most recent commit on ref after the - push. -
    createdbooleanWhether this push created the ref.
    deletedbooleanWhether this push deleted the ref.
    forcedbooleanWhether this push was a force push of the ref.
    head_commitobject - For pushes where after is or points to a commit - object, an expanded representation of that commit. For pushes - where after refers to an annotated tag object, an - expanded representation of the commit pointed to by the annotated - tag. -
    comparestring - 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. -
    commitsarray - 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.) -
    commits[][id]stringThe SHA of the commit.
    commits[][timestamp]stringThe ISO 8601 timestamp of the commit.
    commits[][message]stringThe commit message.
    commits[][author]objectThe git author of the commit.
    commits[][author][name]stringThe git author's name.
    commits[][author][email]stringThe git author's email address.
    commits[][url]urlURL that points to the commit API resource.
    commits[][distinct]boolean - Whether this commit is distinct from any that have been pushed - before. -
    commits[][added]array - An array of files added in the commit. For extremely large commits - where GitHub AE is unable to calculate this list in a timely - manner, this may be empty even if files were added. -
    commits[][modified]array - An array of files modified by the commit. For extremely large - commits where GitHub AE is unable to calculate this list in a - timely manner, this may be empty even if files were modified. -
    commits[][removed]array - An array of files removed in the commit. For extremely large - commits where GitHub AE is unable to calculate this list in a - timely manner, this may be empty even if files were removed. -
    pusherobjectThe user who pushed the commits.
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + after string + Required +
    +
    +
    +

    + The SHA of the most recent commit on + ref after the push. +

    +
    +
    +
    +
    +
    +
    +
    + base_ref string or null + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + before string + Required +
    +
    +
    +

    + The SHA of the most recent commit on + ref before the push. +

    +
    +
    +
    +
    +
    +
    +
    + commits array of objects + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + compare string + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    + created boolean + Required +
    +
    +
    +

    + Whether this push created the ref. +

    +
    +
    +
    +
    +
    +
    +
    + deleted boolean + Required +
    +
    +
    +

    + Whether this push deleted the ref. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + forced boolean + Required +
    +
    +
    +

    + Whether this push was a force push of the + ref. +

    +
    +
    +
    +
    +
    +
    +
    + head_commit object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + pusher object + Required +
    +
    +
    +

    + Metaproperties for Git author/committer + information. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + ref string + Required +
    +
    +
    +

    + The full git ref that was pushed. Example: + refs/heads/main or + refs/tags/v3.14.1. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +

    A git repository

    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + registry_package +

    +
    +
    +

    + 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. +

    +

    + To install this event on a GitHub App, the app must have at + least read-level access for the "Packages" repository + permission. +

    +

    + Note: GitHub recommends that you use the newer + package event instead. +

    +
    +

    Availability for registry_package

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for registry_package

    +
    +
    + +
    +
    +

    A package was published to a registry.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + registry_package object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + release +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Contents" repository permission. +

    +
    +

    Availability for release

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for release

    +
    +
    + +
    +
    +
    +

    + A draft was saved, or a release or pre-release was published + without previously being saved as a draft. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "ref": "refs/tags/simple-tag",
-  "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
-  "after": "0000000000000000000000000000000000000000",
-  "created": false,
-  "deleted": true,
-  "forced": false,
-  "base_ref": null,
-  "compare": "https://octocoders.github.io/Codertocat/Hello-World/compare/4544205a3853...000000000000",
-  "commits": [],
-  "head_commit": null,
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "name": "Codertocat",
-      "email": "Codertocat@octocoders.github.io",
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": 1557949027,
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": 1557949103,
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master",
-    "stargazers": 0,
-    "master_branch": "master"
-  },
-  "pusher": {
-    "name": "Codertocat",
-    "email": "Codertocat@octocoders.github.io"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + release object + Required +
    +
    +
    +

    + The + release + object. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - release -

    -

    - Activity related to a release. The type of activity is specified in the - action property of the payload object. For more - information, see the "releases" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of: -
      -
    • - published: a release, pre-release, or draft of a - release is published -
      • -
    • - unpublished: a release or pre-release is deleted -
      • -
    • - created: a draft is saved, or a release or - pre-release is published without previously being saved as a - draft -
      • -
    • - edited: a release, pre-release, or draft release - is edited -
      • -
    • - deleted: a release, pre-release, or draft release - is deleted -
      • -
    • prereleased: a pre-release is created
      • -
    • - released: a release is published, or a - pre-release is changed to a release -
      • -
    -
    changes[body][from]string - The previous version of the body if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    releaseobject - The - release +
    +

    + repository_advisory +

    +
    +
    +

    + This event occurs when there is activity relating to a + repository security advisory. For more information about + repository security advisories, see "About GitHub Security Advisories for repositories." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Repository security advisories" + permission. +

    +
    +

    Availability for repository_advisory

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for repository_advisory

    +
    +
    + +
    +
    +

    A repository security advisory was published.

    +
    + - object. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + repository_advisory object + Required +
    +
    +

    A repository security advisory.

    +
    +
    +
    +
    +
    + +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + repository +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    +
    +

    Availability for repository

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for repository

    +
    +
    + +
    +
    +

    A repository was archived.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: archived +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    + repository_dispatch +

    +
    +
    +

    + 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. +

    +
    +

    Availability for repository_dispatch

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for repository_dispatch

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "release": {
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2",
-    "assets_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets",
-    "upload_url": "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1",
-    "id": 2,
-    "node_id": "MDc6UmVsZWFzZTI=",
-    "tag_name": "0.0.1",
-    "target_commitish": "master",
-    "name": null,
-    "draft": false,
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "prerelease": false,
-    "created_at": "2019-05-15T19:37:08Z",
-    "published_at": "2019-05-15T19:38:20Z",
-    "assets": [],
-    "tarball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1",
-    "zipball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1",
-    "body": null
-  },
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +

    + The event_type that was specified in + the + POST /repos/{owner}/{repo}/dispatches + request body. +

    +
    +
    +
    +
    +
    +
    +
    + branch string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + client_payload + object or null Required +
    +
    +
    +

    + The client_payload that was specified + in the + POST /repos/{owner}/{repo}/dispatches + request body. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + installation object + Required +
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - repository_dispatch -

    -

    - This event occurs when a GitHub App sends a POST request to - the "Create a repository dispatch event" endpoint. -

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "on-demand-test",
-  "branch": "master",
-  "client_payload": {
-    "unit": false,
-    "integration": true
-  },
-  "repository": {
-    "id": 17273051,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
-    "name": "octo-repo",
-    "full_name": "octo-org/octo-repo",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 6811672,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/octo-repo",
-    "description": "My first repo on GitHub!",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/octo-repo",
-    "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
-    "created_at": "2014-02-28T02:42:51Z",
-    "updated_at": "2018-10-10T15:58:51Z",
-    "pushed_at": "2018-10-10T15:58:47Z",
-    "git_url": "git://github.com/octo-org/octo-repo.git",
-    "ssh_url": "git@github.com:octo-org/octo-repo.git",
-    "clone_url": "https://github.com/octo-org/octo-repo.git",
-    "svn_url": "https://github.com/octo-org/octo-repo",
-    "homepage": "",
-    "size": 59,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "JavaScript",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 23,
-    "license": null,
-    "forks": 1,
-    "open_issues": 23,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 6811672,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
-    "description": "Working better together!"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 375706,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2"
-  }
-}
-
    +
    +
    +

    + repository_import +

    +
    +
    +

    + This event occurs when a repository is imported to GitHub + Enterprise Cloud. For more information, see "Importing a repository with GitHub Importer." For more information about the API to manage imports, see + the REST API documentation. +

    +
    +

    Availability for repository_import

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    +

    Webhook payload object for repository_import

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + status string + Required +
    +
    +
    +
    +

    + Can be one of: success, cancelled, failure +

    +
    +
    +
    +
    +
    +
    +
    -

    - - repository -

    -

    - Activity related to a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "repositories" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. This can be one of: -
      -
    • created - A repository is created.
      • -
    • deleted - A repository is deleted.
      • -
    • archived - A repository is archived.
      • -
    • unarchived - A repository is unarchived.
      • -
    • - anonymous_access_enabled - A repository is - enabled for anonymous Git access, anonymous_access_disabled - A repository is - disabled for anonymous Git access -
      • -
    • - edited - A repository's information is edited. -
      • -
    • renamed - A repository is renamed.
      • -
    • transferred - A repository is transferred.
      • -
    • publicized - A repository is made public.
      • -
    • privatized - A repository is made private.
      • -
    -
    repositoryobject - The - repository +
    +

    + repository_ruleset +

    +
    +
    +

    + This event occurs when there is activity relating to repository + rulesets. For more information about repository rulesets, see + "Managing rulesets." For 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." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository or + organization permission. +

    +
    +

    Availability for repository_ruleset

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for repository_ruleset

    +
    +
    + +
    +
    +

    A repository ruleset was created.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + repository_ruleset object + Required +
    +
    +
    +

    + A set of rules to apply when specified conditions + are met. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + repository_vulnerability_alert +

    +
    +
    +

    + This event occurs when there is activity relating to a security + vulnerability alert in a repository. +

    +

    + Note: This event is deprecated. Use the + dependabot_alert event instead. +

    +
    +

    + Availability for repository_vulnerability_alert +

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    +

    + Webhook payload object for + repository_vulnerability_alert +

    +
    +
    + +
    +
    +

    A repository vulnerability alert was created.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "publicized",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:25Z",
-    "pushed_at": "2019-05-15T19:38:23Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: create +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +

    + The security alert of the vulnerable dependency. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    + + -

    - - star -

    -

    - Activity related to a repository being starred. The type of activity is - specified in the action property of the payload object. For - more information, see the "starring" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be created or - deleted. -
    starred_atstring - 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. -
    repositoryobject - The - repository +
    +

    + secret_scanning_alert +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for secret_scanning_alert

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for secret_scanning_alert +

    +
    +
    + +
    +
    +

    A secret scanning alert was created.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + secret_scanning_alert_location +

    +
    +
    +

    + This event occurs when there is activity relating to the + locations of a secret in 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. +

    +

    + For 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. +

    +
    +

    + Availability for secret_scanning_alert_location +

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for + secret_scanning_alert_location +

    +
    +

    + 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. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "starred_at": "2019-05-15T15:20:40Z",
-  "repository": {
-    "id": 186853002,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 21031067,
-      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/Hello-World",
-    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:20:40Z",
-    "pushed_at": "2019-05-15T15:20:33Z",
-    "git_url": "git://github.com/Codertocat/Hello-World.git",
-    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
-    "clone_url": "https://github.com/Codertocat/Hello-World.git",
-    "svn_url": "https://github.com/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 21031067,
-    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    action string
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    + alert object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + location object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - status -

    -

    - When the status of a Git commit changes. For more information, see the - "statuses" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    idintegerThe unique identifier of the status.
    shastringThe Commit SHA.
    statestring - The new state. Can be pending, success, - failure, or error. -
    descriptionstring - The optional human-readable description added to the status. -
    target_urlstringThe optional link added to the status.
    branchesarray - 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. -
    repositoryobject - The - repository +
    +

    + security_advisory +

    +
    +
    +

    + 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. +

    +

    + GitHub Dependabot alerts are also powered by the security + advisory dataset. For more information, see "About Dependabot alerts." +

    +
    +

    Availability for security_advisory

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for security_advisory

    +
    +
    + +
    +
    +
    +

    A security advisory was published to the GitHub community.

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: published +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + security_advisory object + Required +
    +
    +
    +

    + The details of the security advisory, including + summary, description, and severity. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + security_and_analysis +

    +
    +
    +

    + This event occurs when code security and analysis features are + enabled or disabled for a repository. For more information, see + "GitHub security features." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Administration" repository + permission. +

    +
    +

    Availability for security_and_analysis

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    + Webhook payload object for security_and_analysis +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "id": 2,
-  "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-  "name": "Codertocat/Hello-World",
-  "target_url": null,
-  "context": "default",
-  "description": null,
-  "state": "success",
-  "commit": {
-    "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
-    "node_id": "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=",
-    "commit": {
-      "author": {
-        "name": "Codertocat",
-        "email": "Codertocat@octocoders.github.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "committer": {
-        "name": "GitHub Enterprise",
-        "email": "noreply@octocoders.github.io",
-        "date": "2019-05-15T19:37:08Z"
-      },
-      "message": "Initial commit",
-      "tree": {
-        "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4"
-      },
-      "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-      "comment_count": 1,
-      "verification": {
-        "verified": false,
-        "reason": "unsigned",
-        "signature": null,
-        "payload": null
-      }
-    },
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments",
-    "author": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "committer": null,
-    "parents": []
-  },
-  "branches": [
-    {
-      "name": "master",
-      "commit": {
-        "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a"
-      },
-      "protected": false
-    },
-    {
-      "name": "changes",
-      "commit": {
-        "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1"
-      },
-      "protected": false
-    },
-    {
-      "name": "gh-pages",
-      "commit": {
-        "sha": "3648135c2986115284ae152d90459473b15fd19c",
-        "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c"
-      },
-      "protected": false
-    }
-  ],
-  "created_at": "2019-05-15T19:38:21+00:00",
-  "updated_at": "2019-05-15T19:38:21+00:00",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:15Z",
-    "pushed_at": "2019-05-15T19:38:19Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 1,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 1,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + changes object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +

    Full Repository

    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    + + + -

    - - team -

    -

    - Activity related to an organization's team. The type of activity is - specified in the action property of the payload object. For - more information, see the "teams" REST API. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Can be one of created, - deleted, edited, - added_to_repository, or - removed_from_repository. -
    teamobjectThe team itself.
    changesobject - The changes to the team if the action was edited. -
    changes[description][from]string - The previous version of the description if the action was - edited. -
    changes[name][from]string - The previous version of the name if the action was - edited. -
    changes[privacy][from]string - The previous version of the team's privacy if the action was - edited. -
    changes[repository][permissions][from][admin]boolean - The previous version of the team member's - admin permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][pull]boolean - The previous version of the team member's - pull permission on a repository, if the action was - edited. -
    changes[repository][permissions][from][push]boolean - The previous version of the team member's - push permission on a repository, if the action was - edited. -
    repositoryobject - The repository that was added or removed from to the team's - purview if the action was added_to_repository, - removed_from_repository, or edited. For - edited actions, repository also contains - the team's new permission levels for the repository. -
    organizationobject - Webhook payloads contain the - organization +
    +

    + sponsorship +

    +
    +
    +

    + 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. +

    +

    + You can only create a sponsorship webhook on GitHub.com. For + more information, see "Configuring webhooks for events in your sponsored account." +

    +
    +

    Availability for sponsorship

    +
      +
    • Sponsored accounts
      • +
    +

    Webhook payload object for sponsorship

    +
    +
    + +
    +
    +
    +

    + A sponsorship was cancelled and the last billing cycle has + ended. +

    +

    + This event is only sent when a recurring (monthly) sponsorship + is cancelled; it is not sent for one-time sponsorships. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "added_to_repository",
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master",
-    "permissions": {
-      "pull": true,
-      "push": false,
-      "admin": false
-    }
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: cancelled +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + sponsorship object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    + + + -

    - - team_add -

    -

    - When a - repository is added to a team. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    teamobject - The - team that - was modified. Note: Older events may not include - this in the payload. -
    repositoryobject - The - repository +
    +

    + star +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    +
    +

    Availability for star

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for star

    +
    +
    + +
    +
    +

    Someone starred a repository.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: created +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + starred_at string or null + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + status +

    +
    +
    +

    + 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. +

    +
    +

    Availability for status

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for status

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "team": {
-    "name": "github",
-    "id": 3,
-    "node_id": "MDQ6VGVhbTM=",
-    "slug": "github",
-    "description": "Open-source team",
-    "privacy": "secret",
-    "url": "https://octocoders.github.io/api/v3/teams/3",
-    "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
-    "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
-    "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
-    "permission": "pull"
-  },
-  "repository": {
-    "id": 120,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
-    "name": "Hello-World",
-    "full_name": "Octocoders/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Octocoders",
-      "id": 6,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-      "html_url": "https://octocoders.github.io/Octocoders",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "description": null,
-    "fork": true,
-    "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
-    "created_at": "2019-05-15T19:38:10Z",
-    "updated_at": "2019-05-15T19:38:14Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": "Ruby",
-    "has_issues": false,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "organization": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
-    "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
-    "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
-    "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
-    "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
-    "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "description": ""
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Octocoders",
-    "id": 6,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/6?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Octocoders",
-    "html_url": "https://octocoders.github.io/Octocoders",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
-    "type": "Organization",
-    "site_admin": false
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + avatar_url string or null +
    +
    +
    +
    +
    +
    +
    +
    +
    + branches array of objects + Required +
    +
    +
    +

    + 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. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + commit object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + context string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + created_at string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + description string or null + Required +
    +
    +
    +

    + The optional human-readable description added to + the status. +

    +
    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + id integer + Required +
    +
    +

    The unique identifier of the status.

    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + name string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + sha string + Required +
    +
    +

    The Commit SHA.

    +
    +
    +
    +
    +
    +
    + state string + Required +
    +
    +
    +

    + The new state. Can be pending, + success, failure, or + error. +

    +
    +
    +

    + Can be one of: pending, success, failure, error +

    +
    +
    +
    +
    +
    +
    + target_url string or null + Required +
    +
    +
    +

    The optional link added to the status.

    +
    +
    +
    +
    +
    +
    +
    + updated_at string + Required +
    +
    +
    +
    +
    +
    +
    + + + -

    - - user -

    -

    When a user is created or deleted.

    -

    - - Availability -

    - -

    - - Webhook payload example -

    -
    - 
    {
-  "user": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "action": "created",
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Snowtocat",
-    "id": 16,
-    "node_id": "MDQ6VXNlcjE2",
-    "avatar_url": "https://octocoders.github.io/avatars/u/16?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Snowtocat",
-    "html_url": "https://octocoders.github.io/Snowtocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Snowtocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Snowtocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Snowtocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Snowtocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Snowtocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Snowtocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Snowtocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Snowtocat/received_events",
-    "type": "User",
-    "site_admin": false
-  }
-}
-
    +
    +
    +

    + team_add +

    +
    +
    +

    + This event occurs when a team is added to a repository. For more + information, see "Managing teams and people with access to your repository." +

    +

    + For 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. +

    +
    +

    Availability for team_add

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for team_add

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + team object + Required +
    +
    +
    +

    + Groups of organization members that gives + permissions on specified repositories. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    -

    - - watch -

    -

    - When someone stars a repository. The type of activity is specified in - the action property of the payload object. For more - information, see the "starring" REST API. -

    -

    - The event’s actor is the - user who starred - a repository, and the event’s repository is the - repository that - was starred. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action that was performed. Currently, can only be - started. -
    repositoryobject - The - repository +
    +

    + team +

    +
    +
    +

    + This event occurs when there is activity relating to teams in an + organization. For more information, see "About teams." +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Members" organization permission. +

    +
    +

    Availability for team

    +
      +
    • Organizations
      • +
    • Enterprises
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for team

    +
    +
    + +
    +
    +

    A team was granted access to a repository.

    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: added_to_repository +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    + organization object + Required +
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    repository object
    +
    +

    A git repository

    +
    +
    +
    +
    +
    +
    sender object
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + team object + Required +
    +
    +
    +

    + Groups of organization members that gives + permissions on specified repositories. +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    +

    + watch +

    +
    +
    +

    + 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. +

    +

    + To subscribe to this event, a GitHub App must have at least + read-level access for the "Metadata" repository permission. +

    +
    +

    Availability for watch

    +
      +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for watch

    +

    Someone started watching the repository.

    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - - - - - - -
    installationobject - The GitHub App installation. Webhook payloads contain the - installation property when the event is configured - for and sent to a GitHub App. -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "started",
-  "repository": {
-    "id": 118,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
-    "name": "Hello-World",
-    "full_name": "Codertocat/Hello-World",
-    "private": false,
-    "owner": {
-      "login": "Codertocat",
-      "id": 4,
-      "node_id": "MDQ6VXNlcjQ=",
-      "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-      "gravatar_id": "",
-      "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-      "html_url": "https://octocoders.github.io/Codertocat",
-      "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-      "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-      "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-      "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-      "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-      "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": false
-    },
-    "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "description": null,
-    "fork": false,
-    "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
-    "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
-    "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
-    "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
-    "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
-    "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
-    "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
-    "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
-    "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
-    "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
-    "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
-    "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
-    "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
-    "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
-    "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
-    "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
-    "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
-    "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
-    "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
-    "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
-    "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
-    "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
-    "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
-    "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
-    "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
-    "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
-    "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
-    "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
-    "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
-    "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
-    "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
-    "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
-    "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
-    "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
-    "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
-    "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
-    "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
-    "created_at": "2019-05-15T19:37:07Z",
-    "updated_at": "2019-05-15T19:38:09Z",
-    "pushed_at": "2019-05-15T19:38:03Z",
-    "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
-    "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
-    "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
-    "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 1,
-    "watchers_count": 1,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": true,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 1,
-    "default_branch": "master"
-  },
-  "enterprise": {
-    "id": 1,
-    "slug": "github",
-    "name": "GitHub",
-    "node_id": "MDg6QnVzaW5lc3Mx",
-    "avatar_url": "https://octocoders.github.io/avatars/b/1?",
-    "description": null,
-    "website_url": null,
-    "html_url": "https://octocoders.github.io/businesses/github",
-    "created_at": "2019-05-14T19:31:12Z",
-    "updated_at": "2019-05-14T19:31:12Z"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 4,
-    "node_id": "MDQ6VXNlcjQ=",
-    "avatar_url": "https://octocoders.github.io/avatars/u/4?",
-    "gravatar_id": "",
-    "url": "https://octocoders.github.io/api/v3/users/Codertocat",
-    "html_url": "https://octocoders.github.io/Codertocat",
-    "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
-    "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
-    "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
-    "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
-    "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
-    "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": false
-  },
-  "installation": {
-    "id": 5,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: started +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    + + -

    - - workflow_job -

    -

    - A GitHub Actions workflow job has been queued, is in progress, or has - been completed on a repository. The type of activity is specified in the - action property of the payload object. -

    -

    - - Availability -

    - -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstring - The action performed. Can be one of: -
      -
    • queued - A new job was created.
      • -
    • - in_progress - The job has started processing on - the runner. -
      • -
    • - completed - The status of the job is - completed. -
      • -
    -
    workflow_jobobject - The workflow job. Many workflow_job keys, such as - head_sha, conclusion, and - started_at are the same as those in a - check_run object. -
    workflow_job[status]string - The current status of the job. Can be queued, - in_progress, or completed. -
    workflow_job[labels]array - Custom labels for the job. Specified by the - "runs-on" attribute +
    +

    + workflow_dispatch +

    +
    +
    +

    + This event occurs when a GitHub Actions workflow is manually + triggered. For more information, see "Manually running a workflow." +

    +

    + For 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. +

    +
    +

    Availability for workflow_dispatch

    +
      +
    • GitHub Apps
      • +
    +

    Webhook payload object for workflow_dispatch

    +
    +
    + - in the workflow YAML. - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    workflow_job[runner_id]integer - The ID of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_name]string - The name of the runner that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_id]integer - The ID of the runner group that is running this job. This will be - null as long as workflow_job[status] is - queued. -
    workflow_job[runner_group_name]string - The name of the runner group that is running this job. This will - be null as long as - workflow_job[status] is queued. -
    repositoryobject - The - repository + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    + inputs object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + ref string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow string + Required +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    + workflow_job +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for workflow_job

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for workflow_job

    +
    +
    + +
    +
    +
    +

    + 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. +

    +
    +
    + - where the event occurred. - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    organizationobject - Webhook payloads contain the - organization + Webhook request body parameters + +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow_job object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    deployment object
    +
    +
    +

    + A request for a specific ref(branch,sha,tag) to be + deployed +

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    + workflow_run +

    +
    +
    +

    + 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. +

    +

    + For 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. +

    +
    +

    Availability for workflow_run

    +
      +
    • Enterprises
      • +
    • Repositories
      • +
    • Organizations
      • +
    • GitHub Apps
      • +
    +

    Webhook payload object for workflow_run

    +
    +
    + +
    +
    +
    +

    + A workflow run finished. This event occurs when a workflow run + is completed, regardless of whether the workflow was successful + or unsuccessful. +

    +
    +
    + - object when the webhook is configured for an organization or the - event occurs from activity in a repository owned by an - organization. - - - - - - - - -
    senderobjectThe user that triggered the event.
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "in_progress",
-  "workflow_job": {
-    "id": 2832853555,
-    "run_id": 940463255,
-    "run_url": "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255",
-    "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55",
-    "head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055",
-    "url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555",
-    "html_url": "https://github.com/octo-org/example-workflow/runs/2832853555",
-    "status": "in_progress",
-    "conclusion": null,
-    "started_at": "2021-06-15T19:22:27Z",
-    "completed_at": null,
-    "name": "Test workflow",
-    "steps": [
-      {
-        "name": "Set up job",
-        "status": "in_progress",
-        "conclusion": null,
-        "number": 1,
-        "started_at": "2021-06-15T19:22:27.000Z",
-        "completed_at": null
-      }
-    ],
-    "check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555",
-    "labels": [
-      "gpu",
-      "db-app",
-      "dc-03"
-    ],
-    "runner_id": 1,
-    "runner_name": "my runner",
-    "runner_group_id": 2,
-    "runner_group_name": "my runner group"
-  },
-  "repository": {
-    "id": 376034443,
-    "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55",
-    "name": "example-workflow",
-    "full_name": "octo-org/example-workflow",
-    "private": true,
-    "owner": {
-      "login": "octo-org",
-      "id": 33435655,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-      "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/octo-org",
-      "html_url": "https://github.com/octo-org",
-      "followers_url": "https://api.github.com/users/octo-org/followers",
-      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
-      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
-      "organizations_url": "https://api.github.com/users/octo-org/orgs",
-      "repos_url": "https://api.github.com/users/octo-org/repos",
-      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/octo-org/received_events",
-      "type": "Organization",
-      "site_admin": false
-    },
-    "html_url": "https://github.com/octo-org/example-workflow",
-    "description": "Test workflow",
-    "fork": false,
-    "url": "https://api.github.com/repos/octo-org/example-workflow",
-    "forks_url": "https://api.github.com/repos/octo-org/example-workflow/forks",
-    "keys_url": "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/octo-org/example-workflow/teams",
-    "hooks_url": "https://api.github.com/repos/octo-org/example-workflow/hooks",
-    "issue_events_url": "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/octo-org/example-workflow/events",
-    "assignees_url": "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/octo-org/example-workflow/tags",
-    "blobs_url": "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/octo-org/example-workflow/languages",
-    "stargazers_url": "https://api.github.com/repos/octo-org/example-workflow/stargazers",
-    "contributors_url": "https://api.github.com/repos/octo-org/example-workflow/contributors",
-    "subscribers_url": "https://api.github.com/repos/octo-org/example-workflow/subscribers",
-    "subscription_url": "https://api.github.com/repos/octo-org/example-workflow/subscription",
-    "commits_url": "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/octo-org/example-workflow/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/octo-org/example-workflow/merges",
-    "archive_url": "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/octo-org/example-workflow/downloads",
-    "issues_url": "https://api.github.com/repos/octo-org/example-workflow/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/octo-org/example-workflow/labels{/name}",
-    "releases_url": "https://api.github.com/repos/octo-org/example-workflow/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/octo-org/example-workflow/deployments",
-    "created_at": "2021-06-11T13:29:13Z",
-    "updated_at": "2021-06-11T13:33:01Z",
-    "pushed_at": "2021-06-11T13:32:58Z",
-    "git_url": "git://github.com/octo-org/example-workflow.git",
-    "ssh_url": "git@github.com:octo-org/example-workflow.git",
-    "clone_url": "https://github.com/octo-org/example-workflow.git",
-    "svn_url": "https://github.com/octo-org/example-workflow",
-    "homepage": null,
-    "size": 1,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "disabled": false,
-    "open_issues_count": 0,
-    "license": null,
-    "forks": 0,
-    "open_issues": 0,
-    "watchers": 0,
-    "default_branch": "main"
-  },
-  "organization": {
-    "login": "octo-org",
-    "id": 33435655,
-    "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55",
-    "url": "https://api.github.com/orgs/octo-org",
-    "repos_url": "https://api.github.com/orgs/octo-org/repos",
-    "events_url": "https://api.github.com/orgs/octo-org/events",
-    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
-    "issues_url": "https://api.github.com/orgs/octo-org/issues",
-    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
-    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "description": "octo-org"
-  },
-  "sender": {
-    "login": "octocat",
-    "id": 319655,
-    "node_id": "MDQ6VXNlcjMxOTY1NQ55",
-    "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/octocat",
-    "html_url": "https://github.com/octocat",
-    "followers_url": "https://api.github.com/users/octocat/followers",
-    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/octocat/orgs",
-    "repos_url": "https://api.github.com/users/octocat/repos",
-    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/octocat/received_events",
-    "type": "User",
-    "site_admin": true
-  }
-}
-
    +
    + Webhook request body parameters +
    Name, Type, Description
    +
    +
    + action string + Required +
    +
    +
    +
    +

    + Value: completed +

    +
    +
    +
    +
    +
    +
    enterprise object
    +
    +
    +

    + An enterprise on GitHub. Webhook payloads contain + the enterprise property when the + webhook is configured on an enterprise account or + an organization that's part of an enterprise + account. For more information, see "About enterprise accounts." +

    +
    +
    +
    +
    +
    +
    +
    installation object
    +
    +
    +

    + The GitHub App installation. Webhook payloads + contain the installation property + when the event is configured for and sent to a + GitHub App. For more information, see "Using webhooks with GitHub Apps." +

    +
    +
    +
    +
    +
    +
    +
    organization object
    +
    +
    +

    + A GitHub organization. Webhook payloads contain + the organization property when the + webhook is configured for an organization, or when + the event occurs from activity in a repository + owned by an organization. +

    +
    +
    +
    +
    +
    +
    +
    + repository object + Required +
    +
    +
    +

    + The repository on GitHub where the event occurred. + Webhook payloads contain the + repository property when the event + occurs from activity in a repository. +

    +
    +
    +
    +
    +
    +
    +
    + sender object + Required +
    +
    +
    +

    + The GitHub user that triggered the event. This + property is included in every webhook payload. +

    +
    +
    +
    +
    +
    +
    +
    + workflow object or null + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + workflow_run object + Required +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    + + + diff --git a/lib/section-to-webhook.ts b/lib/section-to-webhook.ts index 8f93c9a1b..446ccbda7 100644 --- a/lib/section-to-webhook.ts +++ b/lib/section-to-webhook.ts @@ -47,20 +47,29 @@ const getName = ($: cheerio.Root): string => $("h2").text().trim(); const getDescription = ($: cheerio.Root): string => $("h2") .nextUntil("h3") - .filter("p") .map((i, el) => $(el).html()) .get() .map((html) => turndownService.turndown(html)) .join("\n\n"); const getPropertiesEl = ($: cheerio.Root): cheerio.Element[][] => { - const $table = $('[id^="webhook-payload-object"]').next("table"); + const $table = $("table"); if (!$table.is("table")) { return []; } - return $table.find("tbody tr").get() as cheerio.Element[][]; + return $table + .find("tbody tr") + .get() + .map((el) => { + const $el = $(el).find("td"); + const keyEl = $el.find("div > code").get()[0] as cheerio.Element; + const descriptionEl = $el.find("div > p").get()[0] as cheerio.Element; + const typeEl = $el.find("div > span:eq(0)").get()[0] as cheerio.Element; + + return [keyEl, typeEl, descriptionEl]; + }) as cheerio.Element[][]; }; const getProperties = ($: cheerio.Root): Webhook["properties"] => { @@ -68,11 +77,9 @@ const getProperties = ($: cheerio.Root): Webhook["properties"] => { const properties: Webhook["properties"] = {}; propertiesEl.forEach((propertyEl) => { - const [keyEl, typeEl, descriptionEl] = $(propertyEl) - .find("td") - .get() as cheerio.Element[]; + const [keyEl, typeEl, descriptionEl] = propertyEl; const key = $(keyEl).text(); - if (key !== "action") { + if (key !== "action" && key !== "") { const type = $(typeEl).text() as JSONSchema7TypeName; const description = turndownService.turndown( $(descriptionEl).html() ?? "", @@ -87,9 +94,7 @@ const getProperties = ($: cheerio.Root): Webhook["properties"] => { const getActions = ($: cheerio.Root): string[] => { const unwantedActions = ["true", "false", "status"]; - const [keyEl, , descriptionEl] = $(getPropertiesEl($)[0]) - .find("td") - .get() as cheerio.Element[]; + const [keyEl, , descriptionEl] = getPropertiesEl($)[0]; if ($(keyEl).text().trim() !== "action") { return []; diff --git a/payload-examples/api.github.com/index.json b/payload-examples/api.github.com/index.json index dee8443d8..0d05ab877 100644 --- a/payload-examples/api.github.com/index.json +++ b/payload-examples/api.github.com/index.json @@ -1,192 +1,57 @@ [ { - "name": "branch_protection_rule", - "description": "Activity related to a branch protection rule. For more information, see \"[About branch protection rules](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules).\"", - "actions": ["created", "deleted", "edited"], + "name": "branch_protection_configuration", + "description": "This event occurs when there is a change to branch protection configurations for a repository. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\n### Availability for `branch_protection_configuration`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `branch_protection_configuration`\n\nAction type: disabled\n\nAll branch protections were disabled for a repository.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `disabled`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "properties": { - "rule": { + "enterprise": { "type": "object", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-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." + "description": "An enterprise on GitHub." }, - "changes": { + "installation": { "type": "object", - "description": "If the action was `edited`, the changes to the rule." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, "repository": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "actions": ["disabled"], + "examples": [] + }, + { + "name": "branch_protection_rule", + "description": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\n### Availability for `branch_protection_rule`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `branch_protection_rule`\n\nAction type: created\n\nA branch protection rule was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`rule` object Required\n\nThe branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-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.\n\nProperties of `rule`\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["created", "deleted", "edited"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "rule": { + "type": "object", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-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." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "edited", - "rule": { - "id": 21796960, - "repository_id": 259377789, - "name": "production", - "created_at": "2021-08-19T12:16:32.000-04:00", - "updated_at": "2021-08-19T12:16:32.000-04:00", - "pull_request_reviews_enforcement_level": "off", - "required_approving_review_count": 1, - "dismiss_stale_reviews_on_push": false, - "require_code_owner_review": false, - "authorized_dismissal_actors_only": false, - "ignore_approvals_from_contributors": false, - "required_status_checks": ["basic-CI"], - "required_status_checks_enforcement_level": "non_admins", - "strict_required_status_checks_policy": false, - "signature_requirement_enforcement_level": "off", - "linear_history_requirement_enforcement_level": "off", - "admin_enforced": false, - "allow_force_pushes_enforcement_level": "off", - "allow_deletions_enforcement_level": "off", - "merge_queue_enforcement_level": "off", - "required_deployments_enforcement_level": "off", - "required_conversation_resolution_level": "off", - "authorized_actors_only": true, - "authorized_actor_names": ["Codertocat"] - }, - "changes": { - "authorized_actors_only": { "from": false }, - "authorized_actor_names": { "from": [] } - }, - "repository": { - "id": 17273051, - "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "My first repo on GitHub!", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2014-02-28T02:42:51Z", - "updated_at": "2021-03-11T14:54:13Z", - "pushed_at": "2021-03-11T14:54:10Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 300, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": false, - "has_downloads": true, - "has_wiki": false, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 39, - "license": null, - "forks": 0, - "open_issues": 39, - "watchers": 0, - "default_branch": "main" - }, - "organization": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "description": "Working better together!" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "action": "created", "rule": { @@ -854,65 +719,30 @@ }, { "name": "check_run", - "description": "Check run activity has occurred. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[check runs](https://docs.github.com/en/rest/reference/checks#runs)\" REST API.", + "description": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The 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`.\n\n### Availability for `check_run`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `check_run`\n\nAction type: completed\n\nA check run was completed, and a conclusion is available.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string\n\nValue: `completed`\n\n`check_run` object Required\n\nA check performed on the code of a given code change\n\nProperties of `check_run`\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": ["completed", "created", "requested_action", "rerequested"], "properties": { "check_run": { "type": "object", - "description": "The [check\\_run](https://docs.github.com/en/rest/reference/checks#get-a-check-run)." - }, - "check_run[status]": { - "type": "string", - "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`." - }, - "check_run[conclusion]": { - "type": "string", - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`." - }, - "check_run[name]": { - "type": "string", - "description": "The name of the check run." - }, - "check_run[check_suite][id]": { - "type": "integer", - "description": "The id of the check suite that this check run is part of." - }, - "check_run[check_suite][pull_requests]": { - "type": "array", - "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty." - }, - "check_run[check_suite][deployment]": { - "type": "object", - "description": "A deployment to a repository environment. This will only be populated if the check run was created by a GitHub Actions workflow job that references an environment." - }, - "requested_action": { - "type": "object", - "description": "The action requested by the user." - }, - "requested_action[identifier]": { - "type": "string", - "description": "The integrator reference of the action requested by the user." + "description": "A check performed on the code of a given code change" }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { - "action": "created", + "action": "completed", "check_run": { "id": 128620228, "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", @@ -920,11 +750,11 @@ "external_id": "", "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", - "details_url": "https://octocoders.github.io", - "status": "queued", - "conclusion": null, + "details_url": "https://octocoders.io", + "status": "completed", + "conclusion": "failure", "started_at": "2019-05-15T15:21:12Z", - "completed_at": null, + "completed_at": "2019-05-15T15:21:12Z", "output": { "title": null, "summary": null, @@ -938,7 +768,7 @@ "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", "head_branch": "changes", "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "status": "queued", + "status": "in_progress", "conclusion": null, "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", @@ -970,6 +800,7 @@ ], "app": { "id": 29310, + "slug": "github-actions", "node_id": "MDM6QXBwMjkzMTA=", "owner": { "login": "Octocoders", @@ -993,38 +824,36 @@ }, "name": "octocoders-linter", "description": "", - "external_url": "https://octocoders.github.io", + "external_url": "https://octocoders.io", "html_url": "https://github.com/apps/octocoders-linter", "created_at": "2019-04-19T19:36:24Z", "updated_at": "2019-04-19T19:36:56Z", "permissions": { - "administration": "write", + "actions": "write", "checks": "write", "contents": "write", "deployments": "write", "issues": "write", "members": "write", "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", + "organization_packages": "write", + "packages": "write", "pages": "write", "pull_requests": "write", "repository_hooks": "write", "repository_projects": "write", + "security_events": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] }, "created_at": "2019-05-15T15:20:31Z", - "updated_at": "2019-05-15T15:20:31Z" + "updated_at": "2019-05-15T15:21:14Z" }, "app": { "id": 29310, + "slug": "github-actions", "node_id": "MDM6QXBwMjkzMTA=", "owner": { "login": "Octocoders", @@ -1048,29 +877,25 @@ }, "name": "octocoders-linter", "description": "", - "external_url": "https://octocoders.github.io", + "external_url": "https://octocoders.io", "html_url": "https://github.com/apps/octocoders-linter", "created_at": "2019-04-19T19:36:24Z", "updated_at": "2019-04-19T19:36:56Z", "permissions": { - "administration": "write", + "actions": "write", "checks": "write", "contents": "write", "deployments": "write", "issues": "write", - "members": "write", "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", + "organization_packages": "write", + "packages": "write", "pages": "write", "pull_requests": "write", "repository_hooks": "write", "repository_projects": "write", + "security_events": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -1099,20 +924,7 @@ } } } - ], - "deployment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", - "id": 326191728, - "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", - "task": "deploy", - "original_environment": "lab", - "environment": "lab", - "description": null, - "created_at": "2021-02-18T08:22:48Z", - "updated_at": "2021-02-18T09:47:16Z", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" - } + ] }, "repository": { "id": 186853002, @@ -1181,7 +993,7 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", + "updated_at": "2019-05-15T15:21:14Z", "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", @@ -1197,320 +1009,20 @@ "has_downloads": true, "has_wiki": true, "has_pages": true, - "forks_count": 1, + "forks_count": 0, "mirror_url": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, - "forks": 1, + "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "completed", - "check_run": { - "id": 128620228, - "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "external_id": "", - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", - "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", - "details_url": "https://octocoders.io", - "status": "completed", - "conclusion": "failure", - "started_at": "2019-05-15T15:21:12Z", - "completed_at": "2019-05-15T15:21:12Z", - "output": { - "title": null, - "summary": null, - "text": null, - "annotations_count": 0, - "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" - }, - "name": "Octocoders-linter", - "check_suite": { - "id": 118578147, - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "changes", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "status": "in_progress", - "conclusion": null, - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ], - "app": { - "id": 29310, - "slug": "github-actions", - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "actions": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "members": "write", - "metadata": "read", - "organization_packages": "write", - "packages": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "security_events": "write", - "statuses": "write", - "vulnerability_alerts": "read" - }, - "events": [] - }, - "created_at": "2019-05-15T15:20:31Z", - "updated_at": "2019-05-15T15:21:14Z" - }, - "app": { - "id": 29310, - "slug": "github-actions", - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "actions": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "metadata": "read", - "organization_packages": "write", - "packages": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "security_events": "write", - "statuses": "write", - "vulnerability_alerts": "read" - }, - "events": [] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ] - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -3590,53 +3102,30 @@ }, { "name": "check_suite", - "description": "Check suite activity has occurred. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[check suites](https://docs.github.com/en/rest/reference/checks#suites)\" REST API.", + "description": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo 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 lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The 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`.\n\n### Availability for `check_suite`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `check_suite`\n\nAction type: completed\n\nAll check runs in a check suite have completed, and a conclusion is available.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `completed`\n\n`check_suite` object Required\n\nThe [check\\_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).\n\nProperties of `check_suite`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": ["completed", "requested", "rerequested"], "properties": { "check_suite": { "type": "object", - "description": "The [check\\_suite](https://docs.github.com/en/rest/reference/checks#suites)." + "description": "The [check\\_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite)." }, - "check_suite[head_branch]": { - "type": "string", - "description": "The head branch name the changes are on." - }, - "check_suite[head_sha]": { - "type": "string", - "description": "The SHA of the most recent commit for this check suite." - }, - "check_suite[status]": { - "type": "string", - "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`." - }, - "check_suite[conclusion]": { - "type": "string", - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`." - }, - "check_suite[url]": { - "type": "string", - "description": "URL that points to the check suite API resource." - }, - "check_suite[pull_requests]": { - "type": "array", - "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty." + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -3644,40 +3133,17 @@ "check_suite": { "id": 118578147, "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "changes", + "head_branch": "main", "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "status": "completed", "conclusion": "success", "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ], + "pull_requests": [], "app": { "id": 29310, + "slug": "github-actions", "node_id": "MDM6QXBwMjkzMTA=", "owner": { "login": "Octocoders", @@ -3701,29 +3167,26 @@ }, "name": "octocoders-linter", "description": "", - "external_url": "https://octocoders.github.io", + "external_url": "https://octocoders.io", "html_url": "https://github.com/apps/octocoders-linter", "created_at": "2019-04-19T19:36:24Z", "updated_at": "2019-04-19T19:36:56Z", "permissions": { - "administration": "write", + "actions": "write", "checks": "write", "contents": "write", "deployments": "write", + "emails": "read", "issues": "write", - "members": "write", "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", + "organization_packages": "write", + "packages": "write", "pages": "write", "pull_requests": "write", "repository_hooks": "write", "repository_projects": "write", + "security_events": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -3824,7 +3287,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": "Twig", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -3839,7 +3302,11 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "main", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -3867,17 +3334,40 @@ "check_suite": { "id": 118578147, "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "main", + "head_branch": "changes", "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "status": "completed", "conclusion": "success", "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [], + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], "app": { "id": 29310, - "slug": "github-actions", "node_id": "MDM6QXBwMjkzMTA=", "owner": { "login": "Octocoders", @@ -3906,21 +3396,24 @@ "created_at": "2019-04-19T19:36:24Z", "updated_at": "2019-04-19T19:36:56Z", "permissions": { - "actions": "write", + "administration": "write", "checks": "write", "contents": "write", "deployments": "write", - "emails": "read", "issues": "write", + "members": "write", "metadata": "read", - "organization_packages": "write", - "packages": "write", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", "pages": "write", "pull_requests": "write", "repository_hooks": "write", "repository_projects": "write", - "security_events": "write", "statuses": "write", + "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -4021,7 +3514,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Twig", + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -4036,7 +3529,7 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "main", + "default_branch": "master", "is_template": false, "topics": [], "visibility": "public", @@ -4269,6 +3762,20 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -4291,42 +3798,18 @@ } }, { - "action": "completed", + "action": "requested", "check_suite": { - "id": 118578147, - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "changes", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "status": "completed", - "conclusion": "success", - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "id": 118578174, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNzQ=", + "head_branch": "master", + "head_sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578174", "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ], + "after": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "pull_requests": [], "app": { "id": 29310, "node_id": "MDM6QXBwMjkzMTA=", @@ -4379,15 +3862,15 @@ }, "events": [] }, - "created_at": "2019-05-15T15:20:31Z", - "updated_at": "2019-05-15T15:21:14Z", - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147/check-runs", + "created_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:20:33Z", + "latest_check_runs_count": 0, + "check_runs_url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578174/check-runs", "head_commit": { - "id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea", - "message": "Update README.md", - "timestamp": "2019-05-15T15:20:30Z", + "id": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "tree_id": "c3e6e174b68ce629340ca817d52393dcf0aed707", + "message": "Add new gemfile", + "timestamp": "2019-05-15T15:20:31Z", "author": { "name": "Codertocat", "email": "21031067+Codertocat@users.noreply.github.com" @@ -4465,8 +3948,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -4475,7 +3958,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -4485,10 +3968,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -4496,20 +3979,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -4529,6 +3998,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 957387, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uOTU3Mzg3" } }, { @@ -4606,12 +4079,14 @@ "message": "Add new gemfile", "timestamp": "2019-05-15T15:20:31Z", "author": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" + "name": "github-actions[bot]", + "email": "41898282+github-actions[bot]@users.noreply.github.com", + "username": "github-actions[bot]" }, "committer": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" + "name": "GitHub", + "email": "noreply@github.com", + "username": "web-flow" } } }, @@ -4813,14 +4288,12 @@ "message": "Add new gemfile", "timestamp": "2019-05-15T15:20:31Z", "author": { - "name": "github-actions[bot]", - "email": "41898282+github-actions[bot]@users.noreply.github.com", - "username": "github-actions[bot]" + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com" }, "committer": { - "name": "GitHub", - "email": "noreply@github.com", - "username": "web-flow" + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com" } } }, @@ -4922,6 +4395,20 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -4948,263 +4435,42 @@ } }, { - "action": "requested", + "action": "rerequested", "check_suite": { - "id": 118578174, - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNzQ=", - "head_branch": "master", - "head_sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "status": "queued", - "conclusion": null, - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578174", + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": "success", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "pull_requests": [], - "app": { - "id": 29310, - "node_id": "MDM6QXBwMjkzMTA=", - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "name": "octocoders-linter", - "description": "", - "external_url": "https://octocoders.io", - "html_url": "https://github.com/apps/octocoders-linter", - "created_at": "2019-04-19T19:36:24Z", - "updated_at": "2019-04-19T19:36:56Z", - "permissions": { - "administration": "write", - "checks": "write", - "contents": "write", - "deployments": "write", - "issues": "write", - "members": "write", - "metadata": "read", - "organization_administration": "write", - "organization_hooks": "write", - "organization_plan": "read", - "organization_projects": "write", - "organization_user_blocking": "write", - "pages": "write", - "pull_requests": "write", - "repository_hooks": "write", - "repository_projects": "write", - "statuses": "write", - "team_discussions": "write", - "vulnerability_alerts": "read" - }, - "events": [] - }, - "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:33Z", - "latest_check_runs_count": 0, - "check_runs_url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578174/check-runs", - "head_commit": { - "id": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "tree_id": "c3e6e174b68ce629340ca817d52393dcf0aed707", - "message": "Add new gemfile", - "timestamp": "2019-05-15T15:20:31Z", - "author": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - }, - "committer": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - } - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 1, - "license": null, - "forks": 0, - "open_issues": 1, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 957387, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uOTU3Mzg3" - } - }, - { - "action": "rerequested", - "check_suite": { - "id": 118578147, - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "head_branch": "changes", - "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "status": "completed", - "conclusion": "success", - "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "pull_requests": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "number": 2, - "head": { - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - }, - "base": { - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "repo": { - "id": 186853002, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "name": "Hello-World" - } - } - } - ], + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], "app": { "id": 29310, "node_id": "MDM6QXBwMjkzMTA=", @@ -5648,208 +4914,46 @@ }, { "name": "code_scanning_alert", - "description": "Activity related to code scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see \"[About code scanning](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning).\"", + "description": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.\n\n### Availability for `code_scanning_alert`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `code_scanning_alert`\n\nAction type: appeared\\_in\\_branch\n\nA 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.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `appeared_in_branch`\n\n`alert` object Required\n\nThe code scanning alert involved in the event.\n\nProperties of `alert`\n\n`commit_oid` string Required\n\nThe 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.\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`ref` string Required\n\nThe 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.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [ "appeared_in_branch", "closed_by_user", "created", "fixed", - "reopened", - "reopened_by_user" + "reopened" ], "properties": { "alert": { "type": "object", "description": "The code scanning alert involved in the event." }, - "ref": { - "type": "string", - "description": "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." - }, "commit_oid": { "type": "string", "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." }, - "repository": { + "enterprise": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "An enterprise on GitHub." }, - "organization": { + "installation": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "installation": { + "organization": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A GitHub organization." }, - "sender": { + "ref": { + "type": "string", + "description": "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." + }, + "repository": { "type": "object", - "description": "If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is `github` for all other actions." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "reopened", - "alert": { - "number": 10, - "created_at": "2020-07-22T14:06:31Z", - "updated_at": "2020-07-22T14:06:31Z", - "url": "https://api.github.com/repos/Codertocat/Hello-World/code-scanning/alerts/10", - "html_url": "https://github.com/Codertocat/Hello-World/security/code-scanning/10", - "instances": [ - { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/workflow.yml:upload", - "environment": "{}", - "state": "open" - } - ], - "state": "open", - "fixed_at": null, - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "rule": { - "id": "Style/FrozenStringLiteralComment", - "severity": "note", - "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.", - "full_description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.", - "tags": ["style"], - "help": "Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged\n--- | --- | --- | --- | ---\nEnabled | No | Yes (Unsafe) | 0.36 | 0.79\n\nThis cop is designed to help you transition from mutable string literals\nto frozen string literals.\nIt will add the comment `# frozen_string_literal: true` to the top of\nfiles to enable frozen string literals. Frozen string literals may be\ndefault in future Ruby. The comment will be added below a shebang and\nencoding comment. The frozen string literal comment is only valid in\nRuby 2.3+.\n\nNote that the cop will ignore files where the comment exists but is set\nto `false` instead of `true`.\n\n### Examples\n\n#### EnforcedStyle: always (default)\n\n```ruby\n# The `always` style will always add the frozen string literal comment\n# to a file, regardless of the Ruby version or if `freeze` or `<<` are\n# called on a string literal.\n# bad\nmodule Bar\n # ...\nend\n\n# good\n# frozen_string_literal: true\n\nmodule Bar\n # ...\nend\n\n# good\n# frozen_string_literal: false\n\nmodule Bar\n # ...\nend\n```\n#### EnforcedStyle: never\n\n```ruby\n# The `never` will enforce that the frozen string literal comment does\n# not exist in a file.\n# bad\n# frozen_string_literal: true\n\nmodule Baz\n # ...\nend\n\n# good\nmodule Baz\n # ...\nend\n```\n#### EnforcedStyle: always_true\n\n```ruby\n# The `always_true` style enforces that the frozen string literal\n# comment is set to `true`. This is a stricter option than `always`\n# and forces projects to use frozen string literals.\n# bad\n# frozen_string_literal: false\n\nmodule Baz\n # ...\nend\n\n# bad\nmodule Baz\n # ...\nend\n\n# good\n# frozen_string_literal: true\n\nmodule Bar\n # ...\nend\n```\n\n### Configurable attributes\n\nName | Default value | Configurable values\n--- | --- | ---\nEnforcedStyle | `always` | `always`, `always_true`, `never`\n\n" - }, - "tool": { "name": "Rubocop", "version": null } - }, - "ref": "refs/heads/main", - "commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "main" - }, - "organization": { - "login": "Octocoders", - "id": 6, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars0.githubusercontent.com/u/6?", - "description": "" - }, - "sender": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - } - }, { "action": "closed_by_user", "alert": { @@ -6775,29 +5879,30 @@ }, { "name": "commit_comment", - "description": "A commit comment is created. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[commit comment](https://docs.github.com/en/rest/reference/repos#comments)\" REST API.", + "description": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n### Availability for `commit_comment`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `commit_comment`\n\nSomeone commented on a commit.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nThe action performed. Can be `created`.\n\nValue: `created`\n\n`comment` object Required\n\nThe [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource.\n\nProperties of `comment`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": ["created"], "properties": { "comment": { "type": "object", - "description": "The [commit comment](https://docs.github.com/en/rest/reference/commits#get-a-commit-comment) resource." + "description": "The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource." }, - "repository": { + "enterprise": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "An enterprise on GitHub." }, - "organization": { + "installation": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "installation": { + "organization": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -6827,9 +5932,9 @@ "type": "User", "site_admin": false }, - "position": null, - "line": null, - "path": null, + "position": 1, + "line": 1, + "path": "README.md", "commit_id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "created_at": "2019-05-15T15:20:39Z", "updated_at": "2019-05-15T15:20:39Z", @@ -6928,7 +6033,11 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -6978,9 +6087,9 @@ "type": "User", "site_admin": false }, - "position": 1, - "line": 1, - "path": "README.md", + "position": null, + "line": null, + "path": null, "commit_id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", "created_at": "2019-05-15T15:20:39Z", "updated_at": "2019-05-15T15:20:39Z", @@ -7240,6 +6349,20 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -7259,6 +6382,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { @@ -7428,20 +6555,67 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "create", + "description": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are created at once.\n\n### Availability for `create`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `create`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`description` string or null Required\n\nThe repository's current description.\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`master_branch` string Required\n\nThe name of the repository's default branch (usually `main`).\n\n`organization` object\n\nA GitHub organization.\n\n`pusher_type` string Required\n\nThe pusher type for the event. Can be either `user` or a deploy key.\n\n`ref` string Required\n\nThe [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource.\n\n`ref_type` string Required\n\nThe type of Git ref object created in the repository.\n\nCan be one of: `tag`, `branch`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": [], + "properties": { + "description": { + "type": "string or null", + "description": "The repository's current description." + }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "master_branch": { + "type": "string", + "description": "The name of the repository's default branch (usually `main`)." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "pusher_type": { + "type": "string", + "description": "The pusher type for the event. Can be either `user` or a deploy key." + }, + "ref": { + "type": "string", + "description": "The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource." }, + "ref_type": { + "type": "string", + "description": "The type of Git ref object created in the repository." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "created", - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/comments/33548674", - "html_url": "https://github.com/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246#commitcomment-33548674", - "id": 33548674, - "node_id": "MDEzOkNvbW1pdENvbW1lbnQzMzU0ODY3NA==", - "user": { + "ref": "simple-tag", + "ref_type": "tag", + "master_branch": "master", + "description": null, + "pusher_type": "user", + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -7461,15 +6635,105 @@ "type": "User", "site_admin": false }, - "position": null, - "line": null, - "path": null, - "commit_id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "created_at": "2019-05-15T15:20:39Z", - "updated_at": "2019-05-15T15:20:39Z", - "author_association": "OWNER", - "body": "This is a really good change! :+1:" + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": "2019-05-15T15:20:56Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "ref": "simple-tag", + "ref_type": "tag", + "master_branch": "master", + "description": "Random repository description", + "pusher_type": "user", "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -7537,8 +6801,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": "2019-05-15T15:20:56Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -7553,443 +6817,13 @@ "has_downloads": true, "has_wiki": true, "has_pages": true, - "forks_count": 0, + "forks_count": 1, "mirror_url": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "create", - "description": "A Git branch or tag is created. For more information, see the \"[Git database](https://docs.github.com/en/rest/reference/git#create-a-reference)\" REST API.", - "actions": [], - "properties": { - "ref": { - "type": "string", - "description": "The [`git ref`](https://docs.github.com/en/rest/reference/git#get-a-reference) resource." - }, - "ref_type": { - "type": "string", - "description": "The type of Git ref object created in the repository. Can be either `branch` or `tag`." - }, - "master_branch": { - "type": "string", - "description": "The name of the repository's default branch (usually `main`)." - }, - "description": { - "type": "string", - "description": "The repository's current description." - }, - "pusher_type": { - "type": "string", - "description": "The pusher type for the event. Can be either `user` or a deploy key." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "ref": "simple-tag", - "ref_type": "tag", - "master_branch": "master", - "description": null, - "pusher_type": "user", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:56Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "ref": "simple-tag", - "ref_type": "tag", - "master_branch": "master", - "description": null, - "pusher_type": "user", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:56Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "ref": "simple-tag", - "ref_type": "tag", - "master_branch": "master", - "description": "Random repository description", - "pusher_type": "user", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:56Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, + "forks": 1, "open_issues": 2, "watchers": 0, "default_branch": "master", @@ -8291,158 +7125,40 @@ }, { "name": "delete", - "description": "A Git branch or tag is deleted. For more information, see the \"[Git database](https://docs.github.com/en/rest/reference/git#delete-a-reference)\" REST API.", + "description": "This event occurs when a Git branch or tag is deleted.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.\n\n### Availability for `delete`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `delete`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`pusher_type` string Required\n\nThe pusher type for the event. Can be either `user` or a deploy key.\n\n`ref` string Required\n\nThe [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource.\n\n`ref_type` string Required\n\nThe type of Git ref object deleted in the repository.\n\nCan be one of: `tag`, `branch`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [], "properties": { - "ref": { - "type": "string", - "description": "The [`git ref`](https://docs.github.com/en/rest/reference/git#get-a-reference) resource." + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, - "ref_type": { - "type": "string", - "description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`." + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, "pusher_type": { "type": "string", "description": "The pusher type for the event. Can be either `user` or a deploy key." }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "ref": { + "type": "string", + "description": "The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource." }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "ref_type": { + "type": "string", + "description": "The type of Git ref object deleted in the repository." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "ref": "simple-tag", - "ref_type": "tag", - "pusher_type": "user", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "ref": "simple-tag", "ref_type": "tag", @@ -8834,228 +7550,29 @@ }, { "name": "dependabot_alert", - "description": "Activity related to Dependabot alerts. The type of activity is specified in the `action` property of the payload object. For more information, see \"[About Dependabot alerts](https://docs.github.com/en/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "actions": ["created", "dismissed", "fixed", "reintroduced", "reopened"], + "description": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.\n\n### Availability for `dependabot_alert`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `dependabot_alert`\n\nAction type: auto\\_dismissed\n\nA Dependabot alert was automatically closed.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `auto_dismissed`\n\n`alert` object Required\n\nA Dependabot alert.\n\nProperties of `alert`\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["auto_dismissed", "created", "fixed"], "properties": { - "alert": { - "type": "object", - "description": "The Dependabot [`alert`](https://docs.github.com/en/rest/dependabot/alerts#get-a-dependabot-alert) involved in the event." - }, - "repository": { + "alert": { "type": "object", "description": "A Dependabot alert." }, + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "enterprise": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "An enterprise on GitHub." }, - "sender": { + "repository": { "type": "object", - "description": "If the `action` is `dismissed` or `reopened`, the `sender` is the [`user`](https://docs.github.com/en/rest/users/users#get-a-user) that triggered the event. The `sender` is `github` for all other actions." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "fixed", - "alert": { - "number": 1, - "state": "fixed", - "dependency": { - "package": { "ecosystem": "pip", "name": "ansible" }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { "ecosystem": "pip", "name": "ansible" }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { "identifier": "2.9.18" } - }, - { - "package": { "ecosystem": "pip", "name": "ansible" }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { "identifier": "2.8.19" } - }, - { - "package": { "ecosystem": "pip", "name": "ansible" }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { "identifier": "2.10.7" } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { "type": "GHSA", "value": "GHSA-8f4m-hccc-8qph" }, - { "type": "CVE", "value": "CVE-2021-20191" } - ], - "references": [ - { "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { "ecosystem": "pip", "name": "ansible" }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { "identifier": "2.8.19" } - }, - "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-15T13:55:40Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": "2022-06-15T13:55:40Z" - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "hello-world", - "full_name": "octocat/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat/hello-world", - "archive_url": "https://api.github.com/repos/octocat/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octocat/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octocat/hello-world/downloads", - "events_url": "https://api.github.com/repos/octocat/hello-world/events", - "forks_url": "https://api.github.com/repos/octocat/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octocat/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/hello-world/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/hello-world/languages", - "merges_url": "https://api.github.com/repos/octocat/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octocat/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octocat/hello-world/tags", - "teams_url": "https://api.github.com/repos/octocat/hello-world/teams", - "trees_url": "https://api.github.com/repos/octocat/hello-world/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/hello-world/hooks", - "created_at": "2022-06-07T14:08:11Z", - "updated_at": "2022-06-09T16:29:20Z", - "pushed_at": "2022-06-08T15:58:49Z", - "git_url": "git://github.com/octocat/hello-world.git", - "ssh_url": "git@github.com:octocat/hello-world.git", - "clone_url": "https://github.com/octocat/hello-world.git", - "svn_url": "https://github.com/octocat/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Python", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "allow_forking": true, - "is_template": false, - "web_commit_signoff_required": false, - "topics": [], - "visibility": "public", - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "main" - }, - "sender": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - } - }, { "action": "created", "alert": { @@ -9465,25 +7982,30 @@ }, { "name": "deploy_key", - "description": "A deploy key is added or removed from a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[Deploy keys](https://docs.github.com/en/rest/reference/repos#keys)\" REST API.", - "actions": ["created", "deleted"], + "description": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n### Availability for `deploy_key`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `deploy_key`\n\nAction type: created\n\nA deploy key was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`key` object Required\n\nThe [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.\n\nProperties of `key`\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["created"], "properties": { - "key": { + "enterprise": { "type": "object", - "description": "The [`deploy key`](https://docs.github.com/en/rest/reference/deployments#get-a-deploy-key) resource." + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "key": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -9588,7 +8110,11 @@ "forks": 0, "open_issues": 1, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -9610,438 +8136,159 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "deployment", + "description": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n### Availability for `deployment`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `deployment`\n\nA deployment was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`deployment` object Required\n\nThe [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).\n\nProperties of `deployment`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`workflow` object or null Required\n\n`workflow_run` object or null Required", + "actions": ["created"], + "properties": { + "deployment": { + "type": "object", + "description": "The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments)." }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "workflow": { "type": "object or null", "description": "" }, + "workflow_run": { "type": "object or null", "description": "" } + }, + "examples": [ { + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", + "id": 145988746, + "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=", + "task": "deploy", + "original_environment": "github-pages", + "environment": "github-pages", + "description": null, + "created_at": "2022-01-03T01:28:30Z", + "updated_at": "2022-01-03T01:28:40Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", + "creator": { + "login": "github-pages[bot]", + "id": 52472962, + "node_id": "MDM6Qm90NTI0NzI5NjI=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github-pages%5Bbot%5D", + "html_url": "https://github.com/apps/github-pages", + "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers", + "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}", + "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions", + "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs", + "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos", + "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events", + "type": "Bot", + "site_admin": false + }, + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "ref": "gh-pages", + "payload": {}, + "transient_environment": false, + "production_environment": false, + "performed_via_github_app": null + }, "action": "created", - "key": { - "id": 100, - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z", - "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100", - "title": "hey-its-a-deploy-key", - "verified": true, - "created_at": "2019-04-02T17:37:07Z", - "read_only": true + "workflow": { + "id": 17248323, + "node_id": "W_kwDOALyme84BBzBD", + "name": "pages-build-deployment", + "path": "dynamic/pages/pages-build-deployment", + "state": "active", + "created_at": "2022-01-03T01:27:48.000Z", + "updated_at": "2022-01-03T01:27:48.000Z", + "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/workflows/17248323", + "html_url": "https://github.com/Codertocat/Hello-World/blob/master/dynamic/pages/pages-build-deployment", + "badge_url": "https://github.com/Codertocat/Hello-World/workflows/pages-build-deployment/badge.svg" + }, + "workflow_run": { + "id": 289782451, + "name": "pages build and deployment", + "node_id": "WFR_kwLOALyme85iNFsT", + "head_branch": "gh-pages", + "head_sha": "9e602444f49b8b69c3a9a51fa97a115f3d323508", + "run_number": 1, + "event": "dynamic", + "status": "in_progress", + "conclusion": null, + "workflow_id": 17248323, + "check_suite_id": 4812750241, + "check_suite_node_id": "CS_kwDOALyme88AAAABHty9oQ", + "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/runs/289782451", + "html_url": "https://github.com/Codertocat/Hello-World/actions/runs/289782451", + "pull_requests": [], + "created_at": "2022-01-03T01:27:48Z", + "updated_at": "2022-01-03T01:28:40Z", + "run_attempt": 1, + "run_started_at": "2022-01-03T01:27:48Z", + "actor": { + "avatar_url": "https://avatars0.githubusercontent.com/u/15669918?v=4", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", + "html_url": "https://github.com/Codertocat", + "id": 15669918, + "login": "Codertocat", + "node_id": "MDQ6VXNlcjE1NjY5OTE4", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": false, + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "type": "User", + "url": "https://api.github.com/users/Codertocat" + }, + "triggering_actor": { + "avatar_url": "https://avatars0.githubusercontent.com/u/15669918?v=4", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "gravatar_id": "", + "html_url": "https://github.com/Codertocat", + "id": 15669918, + "login": "Codertocat", + "node_id": "MDQ6VXNlcjE1NjY5OTE4", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "site_admin": false, + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "type": "User", + "url": "https://api.github.com/users/Codertocat" + } }, "repository": { - "id": 135493233, - "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": "Hello-World", "full_name": "Codertocat/Hello-World", - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2018-05-30T20:18:04Z", - "updated_at": "2018-05-30T20:18:50Z", - "pushed_at": "2018-05-30T20:18:48Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "open_issues_count": 1, - "license": null, - "forks": 0, - "open_issues": 1, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "deployment", - "description": "A deployment is created. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[deployment](https://docs.github.com/en/rest/reference/deployments#list-deployments)\" REST API.", - "actions": ["created"], - "properties": { - "deployment": { - "type": "object", - "description": "The [deployment](https://docs.github.com/en/rest/reference/deployments#list-deployments)." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "created", - "deployment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", - "id": 145988746, - "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "ref": "master", - "task": "deploy", - "payload": {}, - "original_environment": "production", - "environment": "production", - "description": null, - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2019-05-15T15:20:53Z", - "updated_at": "2019-05-15T15:20:53Z", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "deployment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", - "id": 145988746, - "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=", - "task": "deploy", - "original_environment": "github-pages", - "environment": "github-pages", - "description": null, - "created_at": "2022-01-03T01:28:30Z", - "updated_at": "2022-01-03T01:28:40Z", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", - "creator": { - "login": "github-pages[bot]", - "id": 52472962, - "node_id": "MDM6Qm90NTI0NzI5NjI=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github-pages%5Bbot%5D", - "html_url": "https://github.com/apps/github-pages", - "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers", - "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}", - "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions", - "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs", - "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos", - "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}", - "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events", - "type": "Bot", - "site_admin": false - }, - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "ref": "gh-pages", - "payload": {}, - "transient_environment": false, - "production_environment": false, - "performed_via_github_app": null - }, - "action": "created", - "workflow": { - "id": 17248323, - "node_id": "W_kwDOALyme84BBzBD", - "name": "pages-build-deployment", - "path": "dynamic/pages/pages-build-deployment", - "state": "active", - "created_at": "2022-01-03T01:27:48.000Z", - "updated_at": "2022-01-03T01:27:48.000Z", - "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/workflows/17248323", - "html_url": "https://github.com/Codertocat/Hello-World/blob/master/dynamic/pages/pages-build-deployment", - "badge_url": "https://github.com/Codertocat/Hello-World/workflows/pages-build-deployment/badge.svg" - }, - "workflow_run": { - "id": 289782451, - "name": "pages build and deployment", - "node_id": "WFR_kwLOALyme85iNFsT", - "head_branch": "gh-pages", - "head_sha": "9e602444f49b8b69c3a9a51fa97a115f3d323508", - "run_number": 1, - "event": "dynamic", - "status": "in_progress", - "conclusion": null, - "workflow_id": 17248323, - "check_suite_id": 4812750241, - "check_suite_node_id": "CS_kwDOALyme88AAAABHty9oQ", - "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/runs/289782451", - "html_url": "https://github.com/Codertocat/Hello-World/actions/runs/289782451", - "pull_requests": [], - "created_at": "2022-01-03T01:27:48Z", - "updated_at": "2022-01-03T01:28:40Z", - "run_attempt": 1, - "run_started_at": "2022-01-03T01:27:48Z", - "actor": { - "avatar_url": "https://avatars0.githubusercontent.com/u/15669918?v=4", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/Codertocat", - "id": 15669918, - "login": "Codertocat", - "node_id": "MDQ6VXNlcjE1NjY5OTE4", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "site_admin": false, - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "type": "User", - "url": "https://api.github.com/users/Codertocat" - }, - "triggering_actor": { - "avatar_url": "https://avatars0.githubusercontent.com/u/15669918?v=4", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/Codertocat", - "id": 15669918, - "login": "Codertocat", - "node_id": "MDQ6VXNlcjE1NjY5OTE4", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "site_admin": false, - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "type": "User", - "url": "https://api.github.com/users/Codertocat" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, + "private": false, "owner": { "login": "Codertocat", "id": 21031067, @@ -10498,10 +8745,73 @@ ] }, { - "name": "deployment_review", - "description": "", + "name": "deployment_protection_rule", + "description": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n### Availability for `deployment_protection_rule`\n\n* GitHub Apps\n\n### Webhook payload object for `deployment_protection_rule`\n\nA deployment protection rule was requested for an environment.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string\n\nValue: `requested`\n\n`environment` string\n\nThe name of the environment that has the deployment protection rule.\n\n`event` string\n\nThe event that triggered the deployment protection rule.\n\n`deployment_callback_url` string\n\nThe URL to review the deployment protection rule.\n\n`deployment` object\n\nA request for a specific ref(branch,sha,tag) to be deployed\n\nProperties of `deployment`\n\n`pull_requests` array of objects\n\nProperties of `pull_requests`\n\n`repository` object\n\nA repository on GitHub.\n\n`organization` object\n\nA GitHub organization.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`sender` object\n\nA GitHub user.", + "properties": { + "environment": { + "type": "string", + "description": "The name of the environment that has the deployment protection rule." + }, + "event": { + "type": "string", + "description": "The event that triggered the deployment protection rule." + }, + "deployment_callback_url": { + "type": "string", + "description": "The URL to review the deployment protection rule." + }, + "deployment": { + "type": "object", + "description": "A request for a specific ref(branch,sha,tag) to be deployed" + }, + "pull_requests": { "type": "array of objects", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, "actions": ["requested"], - "properties": {}, + "examples": [] + }, + { + "name": "deployment_review", + "description": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n### Availability for `deployment_review`\n\n* GitHub Apps\n\n### Webhook payload object for `deployment_review`\n\nAction type: approved\n\nA deployment review was approved.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `approved`\n\n`approver` object\n\nProperties of `approver`\n\n`comment` string\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object Required\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`reviewers` array of objects\n\nProperties of `reviewers`\n\n`sender` object Required\n\nA GitHub user.\n\n`since` string Required\n\n`workflow_job_run` object\n\nProperties of `workflow_job_run`\n\n`workflow_job_runs` array of objects\n\nProperties of `workflow_job_runs`\n\n`workflow_run` object or null Required", + "actions": ["approved", "requested"], + "properties": { + "approver": { "type": "object", "description": "" }, + "comment": { "type": "string", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "reviewers": { "type": "array of objects", "description": "" }, + "sender": { "type": "object", "description": "A GitHub user." }, + "since": { "type": "string", "description": "" }, + "workflow_job_run": { "type": "object", "description": "" }, + "workflow_job_runs": { "type": "array of objects", "description": "" }, + "workflow_run": { "type": "object or null", "description": "" } + }, "examples": [ { "action": "requested", @@ -10941,269 +9251,75 @@ }, { "name": "deployment_status", - "description": "A deployment is created. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[deployments](https://docs.github.com/en/rest/reference/repos#deployments)\" REST API.", + "description": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n### Availability for `deployment_status`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `deployment_status`\n\nA new deployment status was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`check_run` object or null\n\n`deployment` object Required\n\nThe [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).\n\nProperties of `deployment`\n\n`deployment_status` object Required\n\nThe [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).\n\nProperties of `deployment_status`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`workflow` object or null\n\n`workflow_run` object or null", "actions": ["created"], "properties": { - "deployment_status": { + "check_run": { "type": "object or null", "description": "" }, + "deployment": { "type": "object", - "description": "The [deployment status](https://docs.github.com/en/rest/reference/deployments#list-deployment-statuses)." - }, - "deployment_status[\"state\"]": { - "type": "string", - "description": "The new state. Can be `pending`, `success`, `failure`, or `error`." - }, - "deployment_status[\"target_url\"]": { - "type": "string", - "description": "The optional link added to the status." + "description": "The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments)." }, - "deployment_status[\"description\"]": { - "type": "string", - "description": "The optional human-readable description added to the status." + "deployment_status": { + "type": "object", + "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses)." }, - "deployment": { + "enterprise": { "type": "object", - "description": "The [deployment](https://docs.github.com/en/rest/reference/deployments#list-deployments) that this status is associated with." + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." }, + "workflow": { "type": "object or null", "description": "" }, + "workflow_run": { "type": "object or null", "description": "" } }, "examples": [ { - "action": "created", "deployment_status": { "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses/209916254", "id": 209916254, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMyMDk5MTYyNTQ=", - "state": "success", + "state": "in_progress", "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "login": "github-pages[bot]", + "id": 52472962, + "node_id": "MDM6Qm90NTI0NzI5NjI=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "url": "https://api.github.com/users/github-pages%5Bbot%5D", + "html_url": "https://github.com/apps/github-pages", + "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers", + "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}", + "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions", + "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs", + "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos", + "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events", + "type": "Bot", "site_admin": false }, "description": "", - "environment": "production", - "target_url": "", - "created_at": "2019-05-15T15:20:55Z", - "updated_at": "2019-05-15T15:20:55Z", + "environment": "github-pages", + "target_url": "https://github.com/Codertocat/Hello-World/runs/145988746?check_suite_focus=true", + "created_at": "2022-01-03T01:28:40Z", + "updated_at": "2022-01-03T01:28:40Z", "deployment_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" - }, - "deployment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", - "id": 145988746, - "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "ref": "master", - "task": "deploy", - "payload": {}, - "original_environment": "production", - "environment": "production", - "description": null, - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2019-05-15T15:20:53Z", - "updated_at": "2019-05-15T15:20:55Z", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "deployment_status": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses/209916254", - "id": 209916254, - "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMyMDk5MTYyNTQ=", - "state": "in_progress", - "creator": { - "login": "github-pages[bot]", - "id": 52472962, - "node_id": "MDM6Qm90NTI0NzI5NjI=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github-pages%5Bbot%5D", - "html_url": "https://github.com/apps/github-pages", - "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers", - "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}", - "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions", - "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs", - "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos", - "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}", - "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events", - "type": "Bot", - "site_admin": false - }, - "description": "", - "environment": "github-pages", - "target_url": "https://github.com/Codertocat/Hello-World/runs/145988746?check_suite_focus=true", - "created_at": "2022-01-03T01:28:40Z", - "updated_at": "2022-01-03T01:28:40Z", - "deployment_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", - "environment_url": "", - "log_url": "https://github.com/CorsixTH/CorsixTH/runs/4687056418?check_suite_focus=true", - "performed_via_github_app": null + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", + "environment_url": "", + "log_url": "https://github.com/CorsixTH/CorsixTH/runs/4687056418?check_suite_focus=true", + "performed_via_github_app": null }, "deployment": { "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746", @@ -11847,12 +9963,11 @@ }, { "name": "discussion", - "description": "Activity related to a discussion. For more information, see the \"[Using the GraphQL API for discussions](https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions).\"", + "description": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.\n\n### Availability for `discussion`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `discussion`\n\nAction type: answered\n\nA comment on the discussion was marked as the answer.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `answered`\n\n`answer` object Required\n\nProperties of `answer`\n\n`discussion` object Required\n\nA Discussion in a repository.\n\nProperties of `discussion`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [ "answered", "category_changed", "created", - "deleted", "edited", "labeled", "locked", @@ -11860,210 +9975,33 @@ "transferred", "unanswered", "unlabeled", - "unlocked", - "unpinned" + "unlocked" ], "properties": { + "answer": { "type": "object", "description": "" }, "discussion": { "type": "object", - "description": "The [`discussion`](https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions#discussion) resource." + "description": "A Discussion in a repository." }, - "repository": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/graphql/reference/objects#repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/graphql/reference/objects#organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "created", - "discussion": { - "repository_url": "https://api.github.com/repos/octo-org/octo-repo", - "category": { - "id": 32784361, - "node_id": "DIC_kwAqGA", - "repository_id": 17273051, - "emoji": ":speech_balloon:", - "name": "General", - "description": "Chat about anything and everything here", - "created_at": "2021-03-24T12:41:54.000-05:00", - "updated_at": "2021-03-24T12:41:54.000-05:00", - "slug": "general", - "is_answerable": false - }, - "answer_html_url": null, - "answer_chosen_at": null, - "answer_chosen_by": null, - "html_url": "https://github.com/octo-org/octo-repo/discussions/90", - "id": 3297442, - "node_id": "MDEwOkRpc2N1c3Npb24zMjk3NDQy", - "number": 90, - "title": "Welcome to discussions!", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "state": "open", - "locked": false, - "comments": 0, - "created_at": "2021-03-29T14:16:08Z", - "updated_at": "2021-03-29T14:16:08Z", - "author_association": "COLLABORATOR", - "active_lock_reason": null, - "body": "We're glad to have you here!" - }, - "repository": { - "id": 17273051, - "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "My first repo on GitHub!", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2014-02-28T02:42:51Z", - "updated_at": "2021-03-11T14:54:13Z", - "pushed_at": "2021-03-11T14:54:10Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 300, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": false, - "has_downloads": true, - "has_wiki": false, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 39, - "license": null, - "forks": 0, - "open_issues": 39, - "watchers": 0, - "default_branch": "main" - }, - "organization": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "description": "Working better together!" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "action": "answered", "discussion": { @@ -14833,246 +12771,33 @@ }, { "name": "discussion_comment", - "description": "Activity related to a comment in a discussion. For more information, see \"[Using the GraphQL API for discussions](https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions).\"", + "description": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.\n\n### Availability for `discussion_comment`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `discussion_comment`\n\nAction type: created\n\nA comment on a discussion was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`comment` object Required\n\nProperties of `comment`\n\n`discussion` object Required\n\nA Discussion in a repository.\n\nProperties of `discussion`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": ["created", "deleted", "edited"], "properties": { - "comment": { + "comment": { "type": "object", "description": "" }, + "discussion": { "type": "object", - "description": "The [`discussion comment`](https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource." + "description": "A Discussion in a repository." }, - "discussion": { + "enterprise": { "type": "object", - "description": "The [`discussion`](https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions#discussion) resource." + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/graphql/reference/objects#repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/graphql/reference/objects#organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "created", - "comment": { - "id": 544078, - "node_id": "MDE3OkRpc2N1c3Npb25Db21tZW50NTQ0MDc4", - "html_url": "https://github.com/octo-org/octo-repo/discussions/90#discussioncomment-544078", - "parent_id": null, - "child_comment_count": 0, - "repository_url": "octo-org/octo-repo", - "discussion_id": 3297442, - "author_association": "COLLABORATOR", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2021-03-29T14:16:31Z", - "updated_at": "2021-03-29T14:16:31Z", - "body": "I have so many questions to ask you!" - }, - "discussion": { - "repository_url": "https://api.github.com/repos/octo-org/octo-repo", - "category": { - "id": 32784361, - "node_id": "DIC_kwAqGA", - "repository_id": 17273051, - "emoji": ":speech_balloon:", - "name": "General", - "description": "Chat about anything and everything here", - "created_at": "2021-03-24T12:41:54.000-05:00", - "updated_at": "2021-03-24T12:41:54.000-05:00", - "slug": "general", - "is_answerable": false - }, - "answer_html_url": null, - "answer_chosen_at": null, - "answer_chosen_by": null, - "html_url": "https://github.com/octo-org/octo-repo/discussions/90", - "id": 3297442, - "node_id": "MDEwOkRpc2N1c3Npb24zMjk3NDQy", - "number": 90, - "title": "Welcome to discussions!", - "user": { - "login": "Codertocat", - "id": 14935376, - "node_id": "MDQ6VXNlcjE0OTM1Mzc2", - "avatar_url": "https://avatars.githubusercontent.com/u/14935376?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": true - }, - "state": "open", - "locked": false, - "comments": 1, - "created_at": "2021-03-29T14:16:08Z", - "updated_at": "2021-03-29T14:16:31Z", - "author_association": "COLLABORATOR", - "active_lock_reason": null, - "body": "We're glad to have you here!" - }, - "repository": { - "id": 17273051, - "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "My first repo on GitHub!", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2014-02-28T02:42:51Z", - "updated_at": "2021-03-11T14:54:13Z", - "pushed_at": "2021-03-11T14:54:10Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 300, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": false, - "has_downloads": true, - "has_wiki": false, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 39, - "license": null, - "forks": 0, - "open_issues": 39, - "watchers": 0, - "default_branch": "main" - }, - "organization": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "description": "Working better together!" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "action": "created", "comment": { @@ -15738,29 +13463,30 @@ }, { "name": "fork", - "description": "A user forks a repository. For more information, see the \"[forks](https://docs.github.com/en/rest/reference/repos#forks)\" REST API.", + "description": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n### Availability for `fork`\n\n* Enterprises\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `fork`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`forkee` Required\n\nThe created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [], "properties": { - "forkee": { + "enterprise": { "type": "object", - "description": "The created [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) resource." + "description": "An enterprise on GitHub." }, - "repository": { + "forkee": { + "type": "", + "description": "The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource." + }, + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -15857,7 +13583,11 @@ "open_issues": 0, "watchers": 0, "default_branch": "master", - "public": true + "public": true, + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "repository": { "id": 186853002, @@ -15951,7 +13681,11 @@ "forks": 1, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Octocoders", @@ -16191,476 +13925,102 @@ "received_events_url": "https://api.github.com/users/Octocoders/received_events", "type": "Organization", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "github_app_authorization", + "description": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). 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](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n\n### Availability for `github_app_authorization`\n\n* GitHub Apps\n\n### Webhook payload object for `github_app_authorization`\n\nSomeone revoked their authorization of a GitHub App.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `revoked`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["revoked"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "forkee": { - "id": 186853261, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", - "name": "Hello-World", - "full_name": "Octocoders/Hello-World", - "private": false, - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/Octocoders/Hello-World", - "description": null, - "fork": true, - "url": "https://api.github.com/repos/Octocoders/Hello-World", - "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", - "created_at": "2019-05-15T15:20:42Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Octocoders/Hello-World.git", - "ssh_url": "git@github.com:Octocoders/Hello-World.git", - "clone_url": "https://github.com/Octocoders/Hello-World.git", - "svn_url": "https://github.com/Octocoders/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": false, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master", - "public": true, - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } - } - ] - }, - { - "name": "github_app_authorization", - "description": "When someone revokes their authorization of a GitHub App, this event occurs. A GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). 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 user-to-server requests, which require GitHub App authorization, see \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/en/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps).\"", - "actions": ["revoked"], - "properties": { - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "revoked", - "sender": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "revoked", - "sender": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "gollum", - "description": "A wiki page is created or updated. For more information, see \"[About wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis).\"", - "actions": [], - "properties": { - "pages": { - "type": "array", - "description": "The pages that were updated." - }, - "pages[][page_name]": { - "type": "string", - "description": "The name of the page." - }, - "pages[][title]": { - "type": "string", - "description": "The current page title." - }, - "pages[][action]": { - "type": "string", - "description": "The action that was performed on the page. Can be `created` or `edited`." - }, - "pages[][sha]": { - "type": "string", - "description": "The latest commit SHA of the page." - }, - "pages[][html_url]": { - "type": "string", - "description": "Points to the HTML wiki page." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "pages": [ - { - "page_name": "Home", - "title": "Home", - "summary": null, - "action": "edited", - "sha": "6bf911d3801dd1ef957fc6ade5a8d96429e7fa39", - "html_url": "https://github.com/Codertocat/Hello-World/wiki/Home" - } - ], - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:19:26Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "rachmari", - "id": 9831992, - "node_id": "MDQ6VXNlcjk4MzE5OTI=", - "avatar_url": "https://avatars2.githubusercontent.com/u/9831992?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/rachmari", - "html_url": "https://github.com/rachmari", - "followers_url": "https://api.github.com/users/rachmari/followers", - "following_url": "https://api.github.com/users/rachmari/following{/other_user}", - "gists_url": "https://api.github.com/users/rachmari/gists{/gist_id}", - "starred_url": "https://api.github.com/users/rachmari/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/rachmari/subscriptions", - "organizations_url": "https://api.github.com/users/rachmari/orgs", - "repos_url": "https://api.github.com/users/rachmari/repos", - "events_url": "https://api.github.com/users/rachmari/events{/privacy}", - "received_events_url": "https://api.github.com/users/rachmari/received_events", - "type": "User", - "site_admin": true - } - }, - { - "pages": [ - { - "page_name": "Home", - "title": "Home", - "summary": null, - "action": "edited", - "sha": "6bf911d3801dd1ef957fc6ade5a8d96429e7fa39", - "html_url": "https://github.com/Codertocat/Hello-World/wiki/Home" - } - ], + "action": "revoked", + "sender": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + { + "name": "gollum", + "description": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n### Availability for `gollum`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `gollum`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`pages` array of objects Required\n\nThe pages that were updated.\n\nProperties of `pages`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": [], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "pages": { + "type": "array of objects", + "description": "The pages that were updated." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ + { + "pages": [ + { + "page_name": "Home", + "title": "Home", + "summary": null, + "action": "edited", + "sha": "6bf911d3801dd1ef957fc6ade5a8d96429e7fa39", + "html_url": "https://github.com/Codertocat/Hello-World/wiki/Home" + } + ], "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -16918,7 +14278,7 @@ }, { "name": "installation", - "description": "Activity related to a GitHub App installation. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[GitHub App installation](https://docs.github.com/en/rest/reference/apps)\" REST API.", + "description": "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\n### Availability for `installation`\n\n* GitHub Apps\n\n### Webhook payload object for `installation`\n\nAction type: created\n\nSomeone installed a GitHub App on a user or organization account.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object Required\n\nInstallation\n\n`organization` object\n\nA GitHub organization.\n\n`repositories` array of objects\n\nAn array of repository objects that the installation can access.\n\nProperties of `repositories`\n\n`repository` object\n\nA repository on GitHub.\n\n`requester` object or null\n\n`sender` object Required\n\nA GitHub user.", "actions": [ "created", "deleted", @@ -16927,91 +14287,27 @@ "unsuspend" ], "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { "type": "object", "description": "Installation" }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, "repositories": { - "type": "array", + "type": "array of objects", "description": "An array of repository objects that the installation can access." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "requester": { "type": "object or null", "description": "" }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "deleted", - "installation": { - "id": 2, - "account": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "repository_selection": "selected", - "access_tokens_url": "https://api.github.com/installations/2/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/settings/installations/2", - "app_id": 5725, - "target_id": 3880403, - "target_type": "User", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write" - }, - "events": ["push", "pull_request"], - "created_at": 1525109898, - "updated_at": 1525109899, - "single_file_name": "config.yml" - }, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDc=", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "private": false - } - ], - "sender": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - }, { "action": "created", "installation": { @@ -17693,113 +14989,38 @@ }, { "name": "installation_repositories", - "description": "Activity related to repositories being added to a GitHub App installation. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[GitHub App installation](https://docs.github.com/en/rest/reference/apps)\" REST API.", + "description": "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\n### Availability for `installation_repositories`\n\n* GitHub Apps\n\n### Webhook payload object for `installation_repositories`\n\nAction type: added\n\nA GitHub App installation was granted access to one or more repositories.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `added`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object Required\n\nInstallation\n\n`organization` object\n\nA GitHub organization.\n\n`repositories_added` array of objects Required\n\nAn array of repository objects, which were added to the installation.\n\nProperties of `repositories_added`\n\n`repositories_removed` array of objects Required\n\nAn array of repository objects, which were removed from the installation.\n\nProperties of `repositories_removed`\n\n`repository` object\n\nA repository on GitHub.\n\n`repository_selection` string Required\n\nDescribe whether all repositories have been selected or there's a selection involved\n\nCan be one of: `all`, `selected`\n\n`requester` object or null Required\n\n`sender` object Required\n\nA GitHub user.", "actions": ["added", "removed"], "properties": { - "repository_selection": { - "type": "string", - "description": "The choice of repositories the installation is on. Can be either `selected` or `all`." + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { "type": "object", "description": "Installation" }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, "repositories_added": { - "type": "array", + "type": "array of objects", "description": "An array of repository objects, which were added to the installation." }, "repositories_removed": { - "type": "array", + "type": "array of objects", "description": "An array of repository objects, which were removed from the installation." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "repository_selection": { + "type": "string", + "description": "Describe whether all repositories have been selected or there's a selection involved" + }, + "requester": { "type": "object or null", "description": "" }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "added", - "installation": { - "id": 957387, - "account": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repository_selection": "selected", - "access_tokens_url": "https://api.github.com/app/installations/957387/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/settings/installations/957387", - "app_id": 29310, - "target_id": 21031067, - "target_type": "User", - "permissions": { - "administration": "write", - "statuses": "write", - "repository_projects": "write", - "repository_hooks": "write", - "pull_requests": "write", - "pages": "write", - "issues": "write", - "deployments": "write", - "contents": "write", - "checks": "write", - "metadata": "read", - "vulnerability_alerts": "read" - }, - "events": [], - "created_at": 1557933591, - "updated_at": 1557933591, - "single_file_name": null - }, - "repository_selection": "selected", - "repositories_added": [ - { - "id": 186853007, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDc=", - "name": "Space", - "full_name": "Codertocat/Space", - "private": false - } - ], - "repositories_removed": [], - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "action": "added", "installation": { @@ -17983,42 +15204,63 @@ ] }, { - "name": "issue_comment", - "description": "Activity related to an issue or pull request comment. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[issue comments](https://docs.github.com/en/rest/reference/issues#comments)\" REST API.", - "actions": ["created", "deleted", "edited"], + "name": "installation_target", + "description": "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](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\n### Availability for `installation_target`\n\n* GitHub Apps\n\n### Webhook payload object for `installation_target`\n\nSomebody renamed the user or organization account that a GitHub App is installed on.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`account` object Required\n\nProperties of `account`\n\n`action` string Required\n\nValue: `renamed`\n\n`changes` object Required\n\nProperties of `changes`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object Required\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.\n\n`target_type` string Required", "properties": { - "changes": { + "account": { "type": "object", "description": "" }, + "changes": { "type": "object", "description": "" }, + "enterprise": { "type": "object", - "description": "The changes to the comment if the action was `edited`." - }, - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." + "description": "An enterprise on GitHub." }, - "issue": { + "installation": { "type": "object", - "description": "The [issue](https://docs.github.com/en/rest/reference/issues) the comment belongs to." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "comment": { + "organization": { "type": "object", - "description": "The [comment](https://docs.github.com/en/rest/reference/issues#comments) itself." + "description": "A GitHub organization." }, "repository": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "A repository on GitHub." }, - "organization": { + "sender": { "type": "object", "description": "A GitHub user." }, + "target_type": { "type": "string", "description": "" } + }, + "actions": [], + "examples": [] + }, + { + "name": "issue_comment", + "description": "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](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\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](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.\n\n### Availability for `issue_comment`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `issue_comment`\n\nAction type: created\n\nA comment on an issue or pull request was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`comment` object Required\n\nThe [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.\n\nProperties of `comment`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`issue` Required\n\nThe [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["created", "deleted", "edited"], + "properties": { + "comment": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself." + }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, "installation": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "issue": { + "type": "", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -18061,96 +15303,36 @@ "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", "name": "bug", "color": "d73a4a", - "default": true + "default": true, + "description": "Something isn't working" } ], "state": "open", "locked": false, - "assignee": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "assignees": [ - { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", - "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", - "id": 4317517, - "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", - "number": 1, - "title": "v1.0", - "description": "Add new space flight simulator", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 1, - "closed_issues": 0, - "state": "closed", - "created_at": "2019-05-15T15:20:17Z", - "updated_at": "2019-05-15T15:20:18Z", - "due_on": "2019-05-23T07:00:00Z", - "closed_at": "2019-05-15T15:20:18Z" - }, - "comments": 0, - "created_at": "2019-05-15T15:20:18Z", - "updated_at": "2019-05-15T15:20:21Z", + "assignee": null, + "assignees": [], + "milestone": null, + "comments": 2, + "created_at": "2021-01-28T22:17:31Z", + "updated_at": "2021-01-29T05:00:42Z", "closed_at": null, "author_association": "OWNER", - "body": "It looks like you accidently spelled 'commit' with two 't's." + "active_lock_reason": null, + "body": "", + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "performed_via_github_app": null, + "draft": false }, "comment": { "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments/492700400", @@ -18181,7 +15363,20 @@ "created_at": "2019-05-15T15:20:21Z", "updated_at": "2019-05-15T15:20:21Z", "author_association": "OWNER", - "body": "You are totally right! I'll get this fixed right away." + "body": "You are totally right! I'll get this fixed right away.", + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments/492700400/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "performed_via_github_app": null }, "repository": { "id": 186853002, @@ -18275,255 +15470,25 @@ "forks": 0, "open_issues": 1, "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "created", - "issue": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/labels{/name}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/comments", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/events", - "html_url": "https://github.com/Codertocat/Hello-World/issues/1", - "id": 444500041, - "node_id": "MDU6SXNzdWU0NDQ1MDAwNDE=", - "number": 1, - "title": "Spelling error in the README file", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "labels": [ - { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true, - "description": "Something isn't working" - } - ], - "state": "open", - "locked": false, - "assignee": null, - "assignees": [], - "milestone": null, - "comments": 2, - "created_at": "2021-01-28T22:17:31Z", - "updated_at": "2021-01-29T05:00:42Z", - "closed_at": null, - "author_association": "OWNER", - "active_lock_reason": null, - "body": "", - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "performed_via_github_app": null, - "draft": false - }, - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments/492700400", - "html_url": "https://github.com/Codertocat/Hello-World/issues/1#issuecomment-492700400", - "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1", - "id": 492700400, - "node_id": "MDEyOklzc3VlQ29tbWVudDQ5MjcwMDQwMA==", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2019-05-15T15:20:21Z", - "updated_at": "2019-05-15T15:20:21Z", - "author_association": "OWNER", - "body": "You are totally right! I'll get this fixed right away.", - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments/492700400/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "performed_via_github_app": null - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:13Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 1, - "license": null, - "forks": 0, - "open_issues": 1, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" }, "sender": { "login": "Codertocat", @@ -20783,10 +17748,9 @@ }, { "name": "issues", - "description": "Activity related to an issue. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[issues](https://docs.github.com/en/rest/reference/issues)\" REST API.", + "description": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.\n\n### Availability for `issues`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `issues`\n\nAction type: assigned\n\nAn issue was assigned to a user.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nThe action that was performed.\n\nValue: `assigned`\n\n`assignee` object or null\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`issue` object Required\n\nThe [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.\n\nProperties of `issue`\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [ "assigned", - "closed", "deleted", "demilestoned", "edited", @@ -20803,297 +17767,32 @@ "unpinned" ], "properties": { - "issue": { + "assignee": { "type": "object or null", "description": "" }, + "enterprise": { "type": "object", - "description": "The [issue](https://docs.github.com/en/rest/reference/issues) itself." + "description": "An enterprise on GitHub." }, - "changes": { - "type": "object", - "description": "The changes to the issue if the action was `edited`." - }, - "changes[title][from]": { - "type": "string", - "description": "The previous version of the title if the action was `edited`." - }, - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." - }, - "assignee": { - "type": "object", - "description": "The optional user who was assigned or unassigned from the issue." - }, - "label": { + "installation": { "type": "object", - "description": "The optional label that was added or removed from the issue." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "repository": { + "issue": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { - "action": "edited", - "issue": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1", - "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/labels{/name}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/comments", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1/events", - "html_url": "https://github.com/Codertocat/Hello-World/issues/1", - "id": 444500041, - "node_id": "MDU6SXNzdWU0NDQ1MDAwNDE=", - "number": 1, - "title": "Spelling error in the README file", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "labels": [ - { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true - } - ], - "state": "open", - "locked": false, - "assignee": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "assignees": [ - { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", - "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", - "id": 4317517, - "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", - "number": 1, - "title": "v1.0", - "description": "Add new space flight simulator", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 1, - "closed_issues": 0, - "state": "closed", - "created_at": "2019-05-15T15:20:17Z", - "updated_at": "2019-05-15T15:20:18Z", - "due_on": "2019-05-23T07:00:00Z", - "closed_at": "2019-05-15T15:20:18Z" - }, - "comments": 0, - "created_at": "2019-05-15T15:20:18Z", - "updated_at": "2019-05-15T15:20:18Z", - "closed_at": null, - "author_association": "OWNER", - "body": "It looks like you accidently spelled 'commit' with two 't's." - }, - "changes": {}, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:13Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 1, - "license": null, - "forks": 0, - "open_issues": 1, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "assigned", + "action": "assigned", "issue": { "url": "https://api.github.com/repos/Codertocat/Hello-World/issues/1", "repository_url": "https://api.github.com/repos/Codertocat/Hello-World", @@ -28732,48 +25431,38 @@ }, { "name": "label", - "description": "Activity related to a label. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[labels](https://docs.github.com/en/rest/reference/issues#labels)\" REST API.", + "description": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\n\n### Availability for `label`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `label`\n\nAction type: created\n\nA label was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`label` object Required\n\nProperties of `label`\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.", "actions": ["created", "deleted", "edited"], "properties": { - "label": { "type": "object", "description": "The label that was added." }, - "changes": { + "enterprise": { "type": "object", - "description": "The changes to the label if the action was `edited`." - }, - "changes[name][from]": { - "type": "string", - "description": "The previous version of the name if the action was `edited`." - }, - "changes[color][from]": { - "type": "string", - "description": "The previous version of the color if the action was `edited`." + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, + "label": { "type": "object", "description": "" }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { - "action": "deleted", + "action": "created", "label": { "id": 1362937026, "node_id": "MDU6TGFiZWwxMzYyOTM3MDI2", "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix", "name": ":bug: Bugfix", - "color": "cceeaa", + "description": "Fixes a bug", + "color": "cb1f00", "default": false }, "repository": { @@ -28849,7 +25538,7 @@ "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, + "homepage": "", "size": 0, "stargazers_count": 0, "watchers_count": 0, @@ -28868,7 +25557,11 @@ "forks": 1, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -28975,7 +25668,7 @@ "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": "", + "homepage": null, "size": 0, "stargazers_count": 0, "watchers_count": 0, @@ -29149,17 +25842,21 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "created", + "action": "deleted", "label": { "id": 1362937026, "node_id": "MDU6TGFiZWwxMzYyOTM3MDI2", "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix", "name": ":bug: Bugfix", "description": "Fixes a bug", - "color": "cb1f00", + "color": "cceeaa", "default": false }, "repository": { @@ -29279,14 +25976,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "deleted", + "action": "edited", "label": { "id": 1362937026, "node_id": "MDU6TGFiZWwxMzYyOTM3MDI2", @@ -29296,6 +25989,7 @@ "color": "cceeaa", "default": false }, + "changes": { "color": { "from": "cb1f00" } }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -29414,19 +26108,257 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "marketplace_purchase", + "description": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.\n\n### Availability for `marketplace_purchase`\n\n* GitHub Marketplace\n\n### Webhook payload object for `marketplace_purchase`\n\nAction type: cancelled\n\nSomeone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `cancelled`\n\n`effective_date` string Required\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`marketplace_purchase` Required\n\n`organization` object\n\nA GitHub organization.\n\n`previous_marketplace_purchase` object\n\nProperties of `previous_marketplace_purchase`\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["cancelled", "changed", "purchased"], + "properties": { + "effective_date": { "type": "string", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "marketplace_purchase": { "type": "", "description": "" }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, + "previous_marketplace_purchase": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "edited", - "label": { - "id": 1362937026, - "node_id": "MDU6TGFiZWwxMzYyOTM3MDI2", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix", - "name": ":bug: Bugfix", - "description": "Fixes a bug", - "color": "cceeaa", - "default": false + "action": "cancelled", + "effective_date": "2017-10-25T00:00:00+00:00", + "sender": { + "login": "username", + "id": 3877742, + "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/username", + "html_url": "https://github.com/username", + "followers_url": "https://api.github.com/users/username/followers", + "following_url": "https://api.github.com/users/username/following{/other_user}", + "gists_url": "https://api.github.com/users/username/gists{/gist_id}", + "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/username/subscriptions", + "organizations_url": "https://api.github.com/users/username/orgs", + "repos_url": "https://api.github.com/users/username/repos", + "events_url": "https://api.github.com/users/username/events{/privacy}", + "received_events_url": "https://api.github.com/users/username/received_events", + "type": "User", + "site_admin": true, + "email": "username@email.com" + }, + "marketplace_purchase": { + "account": { + "type": "Organization", + "id": 28536653, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "login": "organizationUsername", + "organization_billing_email": "organizationusername@gmail.com" + }, + "billing_cycle": "monthly", + "unit_count": 0, + "on_free_trial": false, + "free_trial_ends_on": null, + "next_billing_date": "2017-11-08T00:00:00+00:00", + "plan": { + "id": 686, + "name": "Premium Plan", + "description": "Premium Plan", + "monthly_price_in_cents": 10000, + "yearly_price_in_cents": 100000, + "price_model": "flat-rate", + "has_free_trial": true, + "unit_name": null, + "bullets": ["Is Expensive", "And Flat Rate"] + } + } + }, + { + "action": "changed", + "effective_date": "2017-10-25T00:00:00+00:00", + "sender": { + "login": "username", + "id": 3877742, + "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/username", + "html_url": "https://github.com/username", + "followers_url": "https://api.github.com/users/username/followers", + "following_url": "https://api.github.com/users/username/following{/other_user}", + "gists_url": "https://api.github.com/users/username/gists{/gist_id}", + "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/username/subscriptions", + "organizations_url": "https://api.github.com/users/username/orgs", + "repos_url": "https://api.github.com/users/username/repos", + "events_url": "https://api.github.com/users/username/events{/privacy}", + "received_events_url": "https://api.github.com/users/username/received_events", + "type": "User", + "site_admin": true, + "email": "username@email.com" + }, + "marketplace_purchase": { + "account": { + "type": "Organization", + "id": 18404719, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "login": "username", + "organization_billing_email": "username@email.com" + }, + "billing_cycle": "monthly", + "unit_count": 10, + "on_free_trial": false, + "free_trial_ends_on": null, + "next_billing_date": "2017-11-05T00:00:00+00:00", + "plan": { + "id": 435, + "name": "Basic Plan", + "description": "Basic Plan", + "monthly_price_in_cents": 1000, + "yearly_price_in_cents": 10000, + "price_model": "per-unit", + "has_free_trial": true, + "unit_name": "seat", + "bullets": ["Is Basic", "Because Basic "] + } + }, + "previous_marketplace_purchase": { + "account": { + "type": "Organization", + "id": 18404719, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "login": "username", + "organization_billing_email": "username@email.com" + }, + "billing_cycle": "monthly", + "on_free_trial": false, + "free_trial_ends_on": null, + "unit_count": 1, + "plan": { + "id": 435, + "name": "Basic Plan", + "description": "Basic Plan", + "monthly_price_in_cents": 1000, + "yearly_price_in_cents": 10000, + "price_model": "per-unit", + "has_free_trial": true, + "unit_name": "seat", + "bullets": ["Is Basic", "Because Basic "] + } + } + }, + { + "action": "purchased", + "effective_date": "2017-10-25T00:00:00+00:00", + "sender": { + "login": "username", + "id": 3877742, + "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/username", + "html_url": "https://github.com/username", + "followers_url": "https://api.github.com/users/username/followers", + "following_url": "https://api.github.com/users/username/following{/other_user}", + "gists_url": "https://api.github.com/users/username/gists{/gist_id}", + "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/username/subscriptions", + "organizations_url": "https://api.github.com/users/username/orgs", + "repos_url": "https://api.github.com/users/username/repos", + "events_url": "https://api.github.com/users/username/events{/privacy}", + "received_events_url": "https://api.github.com/users/username/received_events", + "type": "User", + "site_admin": true, + "email": "username@email.com" + }, + "marketplace_purchase": { + "account": { + "type": "Organization", + "id": 18404719, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "login": "username", + "organization_billing_email": "username@email.com" + }, + "billing_cycle": "monthly", + "unit_count": 1, + "on_free_trial": false, + "free_trial_ends_on": null, + "next_billing_date": "2017-11-05T00:00:00+00:00", + "plan": { + "id": 435, + "name": "Basic Plan", + "description": "Basic Plan", + "monthly_price_in_cents": 1000, + "yearly_price_in_cents": 10000, + "price_model": "per-unit", + "has_free_trial": true, + "unit_name": "seat", + "bullets": ["Is Basic", "Because Basic "] + } + } + } + ] + }, + { + "name": "member", + "description": "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](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\n\n### Availability for `member`\n\n* Enterprises\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `member`\n\nAction type: added\n\nA GitHub user accepted an invitation to a repository.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `added`\n\n`changes` object\n\nProperties of `changes`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`member` object or null Required\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["added", "edited"], + "properties": { + "changes": { "type": "object", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "member": { "type": "object or null", "description": "" }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ + { + "action": "added", + "member": { + "login": "hacktocat", + "id": 39652351, + "node_id": "MDQ6VXNlcjM5NjUyMzUx", + "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/hacktocat", + "html_url": "https://github.com/hacktocat", + "followers_url": "https://api.github.com/users/hacktocat/followers", + "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", + "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", + "organizations_url": "https://api.github.com/users/hacktocat/orgs", + "repos_url": "https://api.github.com/users/hacktocat/repos", + "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "type": "User", + "site_admin": false }, - "changes": { "color": { "from": "cb1f00" } }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -29494,7 +26426,7 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", + "updated_at": "2019-05-15T15:20:41Z", "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", @@ -29525,414 +26457,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "marketplace_purchase", - "description": "Activity related to a GitHub Marketplace purchase. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[GitHub Marketplace](https://docs.github.com/en/marketplace).\"", - "actions": [ - "cancelled", - "changed", - "pending_change", - "pending_change_cancelled", - "purchased" - ], - "properties": {}, - "examples": [ - { - "action": "purchased", - "effective_date": "2017-10-25T00:00:00+00:00", - "sender": { - "login": "username", - "id": 3877742, - "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/username", - "html_url": "https://github.com/username", - "followers_url": "https://api.github.com/users/username/followers", - "following_url": "https://api.github.com/users/username/following{/other_user}", - "gists_url": "https://api.github.com/users/username/gists{/gist_id}", - "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/username/subscriptions", - "organizations_url": "https://api.github.com/users/username/orgs", - "repos_url": "https://api.github.com/users/username/repos", - "events_url": "https://api.github.com/users/username/events{/privacy}", - "received_events_url": "https://api.github.com/users/username/received_events", - "type": "User", - "site_admin": true, - "email": "username@email.com" - }, - "marketplace_purchase": { - "account": { - "type": "Organization", - "id": 18404719, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "login": "username", - "organization_billing_email": "username@email.com" - }, - "billing_cycle": "monthly", - "unit_count": 1, - "on_free_trial": false, - "free_trial_ends_on": null, - "next_billing_date": "2017-11-05T00:00:00+00:00", - "plan": { - "id": 435, - "name": "Basic Plan", - "description": "Basic Plan", - "monthly_price_in_cents": 1000, - "yearly_price_in_cents": 10000, - "price_model": "PER_UNIT", - "has_free_trial": true, - "unit_name": "seat", - "bullets": ["Is Basic", "Because Basic "] - } - } - }, - { - "action": "cancelled", - "effective_date": "2017-10-25T00:00:00+00:00", - "sender": { - "login": "username", - "id": 3877742, - "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/username", - "html_url": "https://github.com/username", - "followers_url": "https://api.github.com/users/username/followers", - "following_url": "https://api.github.com/users/username/following{/other_user}", - "gists_url": "https://api.github.com/users/username/gists{/gist_id}", - "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/username/subscriptions", - "organizations_url": "https://api.github.com/users/username/orgs", - "repos_url": "https://api.github.com/users/username/repos", - "events_url": "https://api.github.com/users/username/events{/privacy}", - "received_events_url": "https://api.github.com/users/username/received_events", - "type": "User", - "site_admin": true, - "email": "username@email.com" - }, - "marketplace_purchase": { - "account": { - "type": "Organization", - "id": 28536653, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "login": "organizationUsername", - "organization_billing_email": "organizationusername@gmail.com" - }, - "billing_cycle": "monthly", - "unit_count": 0, - "on_free_trial": false, - "free_trial_ends_on": null, - "next_billing_date": "2017-11-08T00:00:00+00:00", - "plan": { - "id": 686, - "name": "Premium Plan", - "description": "Premium Plan", - "monthly_price_in_cents": 10000, - "yearly_price_in_cents": 100000, - "price_model": "flat-rate", - "has_free_trial": true, - "unit_name": null, - "bullets": ["Is Expensive", "And Flat Rate"] - } - } - }, - { - "action": "changed", - "effective_date": "2017-10-25T00:00:00+00:00", - "sender": { - "login": "username", - "id": 3877742, - "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/username", - "html_url": "https://github.com/username", - "followers_url": "https://api.github.com/users/username/followers", - "following_url": "https://api.github.com/users/username/following{/other_user}", - "gists_url": "https://api.github.com/users/username/gists{/gist_id}", - "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/username/subscriptions", - "organizations_url": "https://api.github.com/users/username/orgs", - "repos_url": "https://api.github.com/users/username/repos", - "events_url": "https://api.github.com/users/username/events{/privacy}", - "received_events_url": "https://api.github.com/users/username/received_events", - "type": "User", - "site_admin": true, - "email": "username@email.com" - }, - "marketplace_purchase": { - "account": { - "type": "Organization", - "id": 18404719, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "login": "username", - "organization_billing_email": "username@email.com" - }, - "billing_cycle": "monthly", - "unit_count": 10, - "on_free_trial": false, - "free_trial_ends_on": null, - "next_billing_date": "2017-11-05T00:00:00+00:00", - "plan": { - "id": 435, - "name": "Basic Plan", - "description": "Basic Plan", - "monthly_price_in_cents": 1000, - "yearly_price_in_cents": 10000, - "price_model": "per-unit", - "has_free_trial": true, - "unit_name": "seat", - "bullets": ["Is Basic", "Because Basic "] - } - }, - "previous_marketplace_purchase": { - "account": { - "type": "Organization", - "id": 18404719, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "login": "username", - "organization_billing_email": "username@email.com" - }, - "billing_cycle": "monthly", - "on_free_trial": false, - "free_trial_ends_on": null, - "unit_count": 1, - "plan": { - "id": 435, - "name": "Basic Plan", - "description": "Basic Plan", - "monthly_price_in_cents": 1000, - "yearly_price_in_cents": 10000, - "price_model": "per-unit", - "has_free_trial": true, - "unit_name": "seat", - "bullets": ["Is Basic", "Because Basic "] - } - } - }, - { - "action": "purchased", - "effective_date": "2017-10-25T00:00:00+00:00", - "sender": { - "login": "username", - "id": 3877742, - "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/username", - "html_url": "https://github.com/username", - "followers_url": "https://api.github.com/users/username/followers", - "following_url": "https://api.github.com/users/username/following{/other_user}", - "gists_url": "https://api.github.com/users/username/gists{/gist_id}", - "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/username/subscriptions", - "organizations_url": "https://api.github.com/users/username/orgs", - "repos_url": "https://api.github.com/users/username/repos", - "events_url": "https://api.github.com/users/username/events{/privacy}", - "received_events_url": "https://api.github.com/users/username/received_events", - "type": "User", - "site_admin": true, - "email": "username@email.com" - }, - "marketplace_purchase": { - "account": { - "type": "Organization", - "id": 18404719, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "login": "username", - "organization_billing_email": "username@email.com" - }, - "billing_cycle": "monthly", - "unit_count": 1, - "on_free_trial": false, - "free_trial_ends_on": null, - "next_billing_date": "2017-11-05T00:00:00+00:00", - "plan": { - "id": 435, - "name": "Basic Plan", - "description": "Basic Plan", - "monthly_price_in_cents": 1000, - "yearly_price_in_cents": 10000, - "price_model": "per-unit", - "has_free_trial": true, - "unit_name": "seat", - "bullets": ["Is Basic", "Because Basic "] - } - } - } - ] - }, - { - "name": "member", - "description": "Activity related to repository collaborators. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[collaborators](https://docs.github.com/en/rest/reference/repos#collaborators)\" REST API.", - "actions": ["added", "edited", "removed"], - "properties": { - "member": { - "type": "object", - "description": "The [user](https://docs.github.com/en/rest/reference/users) that was added." - }, - "changes": { - "type": "object", - "description": "The changes to the collaborator permissions if the action was `edited`." - }, - "changes[old_permission][from]": { - "type": "string", - "description": "The previous permissions of the collaborator if the action was `edited`." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "added", - "member": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, "sender": { "login": "hacktocat", "id": 39652351, @@ -30093,36 +26617,40 @@ "received_events_url": "https://api.github.com/users/hacktocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "added", + "action": "edited", "member": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars3.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, + "changes": { "old_permission": { "from": "write" } }, "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "id": 135493233, + "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", "name": "Hello-World", "full_name": "Codertocat/Hello-World", - "private": false, "owner": { "login": "Codertocat", "id": 21031067, @@ -30143,6 +26671,7 @@ "type": "User", "site_admin": false }, + "private": false, "html_url": "https://github.com/Codertocat/Hello-World", "description": null, "fork": false, @@ -30183,9 +26712,9 @@ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:57Z", + "created_at": "2018-05-30T20:18:04Z", + "updated_at": "2018-05-30T20:18:35Z", + "pushed_at": "2018-05-30T20:18:48Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -30194,19 +26723,18 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, "has_wiki": true, "has_pages": true, - "forks_count": 1, + "forks_count": 0, "mirror_url": null, "archived": false, - "disabled": false, "open_issues_count": 2, "license": null, - "forks": 1, + "forks": 0, "open_issues": 2, "watchers": 0, "default_branch": "master", @@ -30216,278 +26744,64 @@ "web_commit_signoff_required": false }, "sender": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "membership", + "description": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\n\n### Availability for `membership`\n\n* Organizations\n* Enterprises\n* GitHub Apps\n\n### Webhook payload object for `membership`\n\nAction type: added\n\nAn organization member was added to a team.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `added`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`member` object or null Required\n\n`organization` object Required\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`scope` string Required\n\nThe scope of the membership. Currently, can only be `team`.\n\nValue: `team`\n\n`sender` object or null Required\n\n`team` object Required\n\nGroups of organization members that gives permissions on specified repositories.\n\nProperties of `team`", + "actions": ["added", "removed"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "member": { "type": "object or null", "description": "" }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "scope": { + "type": "string", + "description": "The scope of the membership. Currently, can only be `team`." }, + "sender": { "type": "object or null", "description": "" }, + "team": { + "type": "object", + "description": "Groups of organization members that gives permissions on specified repositories." + } + }, + "examples": [ { - "action": "edited", - "member": { - "login": "octocat", - "id": 583231, - "node_id": "MDQ6VXNlcjU4MzIzMQ==", - "avatar_url": "https://avatars3.githubusercontent.com/u/583231?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "changes": { "old_permission": { "from": "write" } }, - "repository": { - "id": 135493233, - "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2018-05-30T20:18:04Z", - "updated_at": "2018-05-30T20:18:35Z", - "pushed_at": "2018-05-30T20:18:48Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "membership", - "description": "Activity related to team membership. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[team members](https://docs.github.com/en/rest/reference/teams#members)\" REST API.", - "actions": ["added", "removed"], - "properties": { - "scope": { - "type": "string", - "description": "The scope of the membership. Currently, can only be `team`." - }, - "member": { - "type": "object", - "description": "The [user](https://docs.github.com/en/rest/reference/users) that was added or removed." - }, - "team": { - "type": "object", - "description": "The [team](https://docs.github.com/en/rest/reference/teams) for the membership." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "removed", - "scope": "team", - "member": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "team": { - "name": "github", - "id": 3253328, - "node_id": "MDQ6VGVhbTMyNTMzMjg=", - "slug": "github", - "description": "Open-source team", - "privacy": "secret", - "url": "https://api.github.com/teams/3253328", - "html_url": "https://github.com/orgs/Octocoders/teams/github", - "members_url": "https://api.github.com/teams/3253328/members{/member}", - "repositories_url": "https://api.github.com/teams/3253328/repos", - "permission": "pull" - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - } - }, - { - "action": "added", - "scope": "team", + "action": "added", + "scope": "team", "member": { "login": "Codertocat", "id": 21031067, @@ -30765,46 +27079,26 @@ }, { "name": "merge_group", - "description": "Activity related to merge groups in a merge queue. The type of activity is specified in the action property of the payload object.", + "description": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.\n\n### Availability for `merge_group`\n\n* GitHub Apps\n\n### Webhook payload object for `merge_group`\n\nAction type: checks\\_requested\n\nStatus checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `checks_requested`\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`merge_group` object Required\n\nA group of pull requests that the merge queue has grouped together to be merged.\n\nProperties of `merge_group`\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.", "actions": ["checks_requested"], "properties": { - "merge_group": { "type": "object", "description": "The merge group." }, - "merge_group[head_sha]": { - "type": "string", - "description": "The SHA of the merge group." - }, - "merge_group[head_ref]": { - "type": "string", - "description": "The full ref of the merge group." - }, - "merge_group[base_sha]": { - "type": "string", - "description": "The SHA of the merge group's parent commit." - }, - "merge_group[base_ref]": { - "type": "string", - "description": "The full ref of the branch the merge group will be merged into." - }, - "merge_group[head_commit]": { + "installation": { "type": "object", - "description": "An expanded representation of the `head_sha` commit." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "repository": { + "merge_group": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "A group of pull requests that the merge queue has grouped together to be merged." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -30829,161 +27123,6 @@ } } }, - "repository": { - "id": 17273051, - "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "My first repo on GitHub!", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2014-02-28T02:42:51Z", - "updated_at": "2021-03-11T14:54:13Z", - "pushed_at": "2021-03-11T14:54:10Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 300, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": false, - "has_downloads": true, - "has_wiki": false, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 39, - "license": null, - "forks": 0, - "open_issues": 39, - "watchers": 0, - "default_branch": "main" - }, - "organization": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "description": "Working better together!" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=" - } - }, - { - "action": "checks_requested", - "merge_group": { - "head_sha": "2ffea6db159f6b6c47a24e778fb9ef40cf6b1c7d", - "head_ref": "refs/heads/gh-readonly-queue/main/pr-104-929f8209d40f77f4abc622a499c93a83babdbe64", - "base_sha": "380387fbc80638b734a49e1be1c4dfec1c01b33c", - "base_ref": "refs/heads/main", - "head_commit": { - "id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea", - "message": "Merge pull request #2048 from octo-repo/update-readme\n\nUpdate README.md", - "timestamp": "2019-05-15T15:20:30Z", - "author": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - }, - "committer": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - } - } - }, "repository": { "id": 17273051, "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", @@ -31125,29 +27264,34 @@ }, { "name": "meta", - "description": "The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for.", + "description": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.\n\n### Availability for `meta`\n\n* GitHub Marketplace\n* Enterprises\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `meta`\n\nThe webhook was deleted.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `deleted`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`hook` object Required\n\nThe modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.\n\nProperties of `hook`\n\n`hook_id` integer Required\n\nThe id of the modified webhook.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.", "actions": ["deleted"], "properties": { - "hook_id": { - "type": "integer", - "description": "The id of the modified webhook." + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, "hook": { "type": "object", "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace." }, - "repository": { + "hook_id": { + "type": "integer", + "description": "The id of the modified webhook." + }, + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -31162,7 +27306,8 @@ "config": { "content_type": "json", "insecure_ssl": "0", - "url": "http://example.com/hook" + "url": "http://example.com/hook", + "secret": "********" }, "updated_at": "2019-04-10T03:57:12Z", "created_at": "2019-04-10T03:57:12Z" @@ -31258,7 +27403,11 @@ "forks": 0, "open_issues": 1, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -31280,30 +27429,82 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "milestone", + "description": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.\n\n### Availability for `milestone`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `milestone`\n\nAction type: closed\n\nA milestone was closed.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `closed`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`milestone` object Required\n\nA collection of related issues and pull requests.\n\nProperties of `milestone`\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["closed", "created", "deleted"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "milestone": { + "type": "object", + "description": "A collection of related issues and pull requests." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "deleted", - "hook_id": 101047067, - "hook": { - "type": "Repository", - "id": 101047067, - "name": "web", - "active": true, - "events": ["meta"], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "http://example.com/hook", - "secret": "********" + "action": "closed", + "milestone": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", + "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 4317517, + "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", + "number": 1, + "title": "v1.0", + "description": "Add new space flight simulator", + "creator": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false }, - "updated_at": "2019-04-10T03:57:12Z", - "created_at": "2019-04-10T03:57:12Z" + "open_issues": 0, + "closed_issues": 0, + "state": "closed", + "created_at": "2019-05-15T15:20:17Z", + "updated_at": "2019-05-15T15:20:18Z", + "due_on": "2019-05-23T07:00:00Z", + "closed_at": "2019-05-15T15:20:18Z" }, "repository": { - "id": 135493233, - "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", "name": "Hello-World", "full_name": "Codertocat/Hello-World", + "private": false, "owner": { "login": "Codertocat", "id": 21031067, @@ -31324,7 +27525,6 @@ "type": "User", "site_admin": false }, - "private": false, "html_url": "https://github.com/Codertocat/Hello-World", "description": null, "fork": false, @@ -31365,9 +27565,9 @@ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2018-05-30T20:18:04Z", - "updated_at": "2018-05-30T20:18:50Z", - "pushed_at": "2018-05-30T20:18:48Z", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:13Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -31385,364 +27585,11 @@ "forks_count": 0, "mirror_url": null, "archived": false, - "open_issues_count": 1, + "disabled": false, + "open_issues_count": 0, "license": null, "forks": 0, - "open_issues": 1, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "milestone", - "description": "Activity related to milestones. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[milestones](https://docs.github.com/en/rest/reference/issues#milestones)\" REST API.", - "actions": ["closed", "created", "deleted", "edited", "opened"], - "properties": { - "milestone": { "type": "object", "description": "The milestone itself." }, - "changes": { - "type": "object", - "description": "The changes to the milestone if the action was `edited`." - }, - "changes[description][from]": { - "type": "string", - "description": "The previous version of the description if the action was `edited`." - }, - "changes[due_on][from]": { - "type": "string", - "description": "The previous version of the due date if the action was `edited`." - }, - "changes[title][from]": { - "type": "string", - "description": "The previous version of the title if the action was `edited`." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "created", - "milestone": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", - "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", - "id": 4317517, - "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", - "number": 1, - "title": "v1.0", - "description": "Add new space flight simulator", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 0, - "closed_issues": 0, - "state": "open", - "created_at": "2019-05-15T15:20:17Z", - "updated_at": "2019-05-15T15:20:17Z", - "due_on": "2019-05-23T07:00:00Z", - "closed_at": null - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:13Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "closed", - "milestone": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", - "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", - "id": 4317517, - "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", - "number": 1, - "title": "v1.0", - "description": "Add new space flight simulator", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 0, - "closed_issues": 0, - "state": "closed", - "created_at": "2019-05-15T15:20:17Z", - "updated_at": "2019-05-15T15:20:18Z", - "due_on": "2019-05-23T07:00:00Z", - "closed_at": "2019-05-15T15:20:18Z" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:13Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, + "open_issues": 0, "watchers": 0, "default_branch": "master", "is_template": false, @@ -32252,65 +28099,51 @@ ] }, { - "name": "organization", - "description": "Activity related to an organization and its members. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[organizations](https://docs.github.com/en/rest/reference/orgs)\" REST API.", - "actions": [ - "deleted", - "member_added", - "member_invited", - "member_removed", - "renamed" - ], + "name": "org_block", + "description": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.\n\n### Availability for `org_block`\n\n* Organizations\n* Enterprises\n* GitHub Apps\n\n### Webhook payload object for `org_block`\n\nAction type: blocked\n\nA user was blocked from the organization.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `blocked`\n\n`blocked_user` object or null Required\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object Required\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["blocked", "unblocked"], "properties": { - "invitation": { + "blocked_user": { "type": "object or null", "description": "" }, + "enterprise": { "type": "object", - "description": "The invitation for the user or email if the action is `member_invited`." + "description": "An enterprise on GitHub." }, - "membership": { + "installation": { "type": "object", - "description": "The membership between the user and the organization. Not present when the action is `member_invited`." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { - "action": "member_added", - "membership": { - "url": "https://api.github.com/orgs/Octocoders/memberships/hacktocat", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/Octocoders", - "user": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - } + "action": "blocked", + "blocked_user": { + "login": "hacktocat", + "id": 39652351, + "node_id": "MDQ6VXNlcjM5NjUyMzUx", + "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/hacktocat", + "html_url": "https://github.com/hacktocat", + "followers_url": "https://api.github.com/users/hacktocat/followers", + "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", + "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", + "organizations_url": "https://api.github.com/users/hacktocat/orgs", + "repos_url": "https://api.github.com/users/hacktocat/repos", + "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "type": "User", + "site_admin": false }, "organization": { "login": "Octocoders", @@ -32327,53 +28160,47 @@ "description": "" }, "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", "site_admin": false } }, { - "action": "member_added", - "membership": { - "url": "https://api.github.com/orgs/Octocoders/memberships/hacktocat", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/Octocoders", - "user": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - } + "action": "blocked", + "blocked_user": { + "login": "hacktocat", + "id": 39652351, + "node_id": "MDQ6VXNlcjM5NjUyMzUx", + "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/hacktocat", + "html_url": "https://github.com/hacktocat", + "followers_url": "https://api.github.com/users/hacktocat/followers", + "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", + "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", + "organizations_url": "https://api.github.com/users/hacktocat/orgs", + "repos_url": "https://api.github.com/users/hacktocat/repos", + "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "type": "User", + "site_admin": false }, "organization": { "login": "Octocoders", @@ -32390,29 +28217,183 @@ "description": "" }, "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "member_added", - "membership": { + "action": "unblocked", + "blocked_user": { + "login": "hacktocat", + "id": 39652351, + "node_id": "MDQ6VXNlcjM5NjUyMzUx", + "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/hacktocat", + "html_url": "https://github.com/hacktocat", + "followers_url": "https://api.github.com/users/hacktocat/followers", + "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", + "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", + "organizations_url": "https://api.github.com/users/hacktocat/orgs", + "repos_url": "https://api.github.com/users/hacktocat/repos", + "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "type": "User", + "site_admin": false + }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "sender": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + } + } + ] + }, + { + "name": "organization", + "description": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\n\n### Availability for `organization`\n\n* Organizations\n* Enterprises\n* GitHub Apps\n\n### Webhook payload object for `organization`\n\nAction type: deleted\n\nAn organization was deleted.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `deleted`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`membership` object\n\nThe membership between the user and the organization. Not present when the action is `member_invited`.\n\nProperties of `membership`\n\n`organization` object Required\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["deleted", "member_added", "member_invited", "renamed"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "membership": { + "type": "object", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ + { + "action": "member_added", + "membership": { + "url": "https://api.github.com/orgs/Octocoders/memberships/hacktocat", + "state": "pending", + "role": "member", + "organization_url": "https://api.github.com/orgs/Octocoders", + "user": { + "login": "hacktocat", + "id": 39652351, + "node_id": "MDQ6VXNlcjM5NjUyMzUx", + "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/hacktocat", + "html_url": "https://github.com/hacktocat", + "followers_url": "https://api.github.com/users/hacktocat/followers", + "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", + "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", + "organizations_url": "https://api.github.com/users/hacktocat/orgs", + "repos_url": "https://api.github.com/users/hacktocat/repos", + "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/hacktocat/received_events", + "type": "User", + "site_admin": false + } + }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "action": "member_added", + "membership": { "url": "https://api.github.com/orgs/Octocoders/memberships/hacktocat", "state": "pending", "role": "member", @@ -32615,283 +28596,31 @@ ] }, { - "name": "org_block", - "description": "Activity related to people being blocked in an organization. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[blocking organization users](https://docs.github.com/en/rest/reference/orgs#blocking)\" REST API.", - "actions": ["blocked", "unblocked"], + "name": "package", + "description": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n### Availability for `package`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `package`\n\nAction type: published\n\nA package was published to a registry.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `published`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`package` object Required\n\nInformation about the package.\n\nProperties of `package`\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["published"], "properties": { - "blocked_user": { - "type": "object", - "description": "Information about the user that was blocked or unblocked." - }, - "organization": { + "enterprise": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "An enterprise on GitHub." }, "installation": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "sender": { + "organization": { "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "blocked", - "blocked_user": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - } - }, - { - "action": "blocked", - "blocked_user": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - } - }, - { - "action": "blocked", - "blocked_user": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } + "description": "A GitHub organization." }, - { - "action": "unblocked", - "blocked_user": { - "login": "hacktocat", - "id": 39652351, - "node_id": "MDQ6VXNlcjM5NjUyMzUx", - "avatar_url": "https://avatars2.githubusercontent.com/u/39652351?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/hacktocat", - "html_url": "https://github.com/hacktocat", - "followers_url": "https://api.github.com/users/hacktocat/followers", - "following_url": "https://api.github.com/users/hacktocat/following{/other_user}", - "gists_url": "https://api.github.com/users/hacktocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hacktocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hacktocat/subscriptions", - "organizations_url": "https://api.github.com/users/hacktocat/orgs", - "repos_url": "https://api.github.com/users/hacktocat/repos", - "events_url": "https://api.github.com/users/hacktocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/hacktocat/received_events", - "type": "User", - "site_admin": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - } - } - ] - }, - { - "name": "package", - "description": "Activity related to GitHub Packages. The type of activity is specified in the `action` property of the payload object. For more information, see \"[Managing packages with GitHub Packages](https://docs.github.com/en/github/managing-packages-with-github-packages)\" to learn more about GitHub Packages.", - "actions": ["published", "updated"], - "properties": { "package": { "type": "object", "description": "Information about the package." }, "repository": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -32899,11 +28628,11 @@ "package": { "id": 10696, "name": "hello-world-npm", - "namespace": "Codertocat/hello-world-npm", + "namespace": "Codertocat/hello-world", "description": null, "ecosystem": "docker", "package_type": "npm", - "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696", + "html_url": "https://github.com/Codertocat/hello-world/packages/10696", "created_at": "2019-05-09T23:28:29Z", "updated_at": "2019-05-09T23:28:29Z", "owner": { @@ -32927,252 +28656,8 @@ "site_admin": false }, "package_version": { - "id": 24147, - "version": "1.0.0", - "summary": "A simple npm package to demonstrate GitHub Packages", - "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", - "description": "", - "body": "# hello-world-npm\n\nThis is a simple npm package that demonstrates the [Github Packages](https://github.com/features/package).\n\n## Installation \n\n`$ npm install`\n\n## Usage\n\n```\nconst myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n```\n\n", - "body_html": "

    hello-world-npm

    \n

    This is a simple npm package that demonstrates the Github Package Registry.

    \n

    Installation

    \n

    $ npm install

    \n

    Usage

    \n
    const myPackage = require('hello-world-node-package');\nmyPackage.helloWorld();\n
    ", - "release": { - "url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases/17264286", - "html_url": "https://github.com/Codertocat/hello-world-npm/releases/tag/1.0.0", - "id": 17264286, - "tag_name": "1.0.0", - "target_commitish": "master", - "name": "1.0.0", - "draft": false, - "author": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "prerelease": false, - "created_at": "2019-05-09T23:24:40Z", - "published_at": "2019-05-09T23:26:59Z" - }, - "manifest": "{\"_from\":\"\",\"_id\":\"@codertocat/hello-world-npm@1.0.0\",\"_nodeVersion\":\"10.0.0\",\"_npmUser\":{},\"_npmVersion\":\"5.6.0\",\"_shasum\":\"\",\"author\":{\"name\":\"Codertocat\"},\"bugs\":{\"url\":\"https://github.com/Codertocat/hello-world-npm/issues\"},\"description\":\"A simple npm package to demonstrate GitHub Package Registry\",\"dependencies\":null,\"devDependencies\":null,\"peerDependencies\":null,\"dist\":{\"integrity\":\"sha512-CcChRwjJk+pvGVERbgdjc0w5h6HrOs6jK6OJuHmFcmbnGuhiy9tPMtb4WcSSdvwrktAxf96LsJBNqeIHAEHl3A==\",\"shasum\":\"a413c56a12997ca1b56715ebe81d8c6e0ffe6abb\",\"tarball\":\"http://npm.pkg.github.com/@codertocat/hello-world-npm/-/@codertocat/hello-world-npm-1.0.0.tgz\"},\"gitHead\":\"6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b\",\"homepage\":\"https://github.com/Codertocat/hello-world-npm#readme\",\"license\":\"ISC\",\"main\":\"index.js\",\"name\":\"@codertocat/hello-world-npm\",\"repository\":{\"type\":\"git\",\"url\":\"git+https://github.com/Codertocat/hello-world-npm.git\"},\"scripts\":{\"test\":\"echo \\\"Error: no test specified\\\" \\u0026\\u0026 exit 1\"},\"version\":\"1.0.0\"}", - "html_url": "https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.0", - "tag_name": "1.0.0", - "target_commitish": "master", - "target_oid": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", - "draft": false, - "prerelease": false, - "created_at": "2019-05-09T23:28:29Z", - "updated_at": "2019-05-09T23:28:30Z", - "metadata": [], - "docker_metadata": [], - "package_files": [ - { - "download_url": "https://github-production-package-file-4f11e5.s3.amazonaws.com/185882436/3e6d9b00-7288-11e9-9d72-c0df4c711800?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20190509%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190509T232830Z&X-Amz-Expires=300&X-Amz-Signature=4b825c49cd93370123a77d0f97a4ebb0d44efb76da46faf1e382f0c668b35819&X-Amz-SignedHeaders=host&actor_id=0&response-content-disposition=filename%3Dhello-world-npm-1.0.0-npm.tgz&response-content-type=application%2Foctet-stream", - "id": 92167, - "name": "hello-world-npm-1.0.0-npm.tgz", - "sha256": "ba703915435b6ca2ca666b5d8332db34bf9dc37a198ed70d3a5fa5d08b8415c8", - "sha1": "a413c56a12997ca1b56715ebe81d8c6e0ffe6abb", - "md5": "56ebbd5a5a03367f62d0c732bafd3c66", - "content_type": "application/octet-stream", - "state": "uploaded", - "size": 654, - "created_at": "2019-05-09T23:28:30Z", - "updated_at": "2019-05-09T23:28:30Z" - } - ], - "author": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "source_url": "ghcr.io/Codertocat/hello-world-npm/image-1:v1", - "installation_command": "npm install @Codertocat/@1.0.0" - }, - "registry": { - "about_url": "https://help.github.com/about-github-packages", - "name": "GitHub npm registry", - "type": "npm", - "url": "https://npm.pkg.github.com/@Codertocat", - "vendor": "GitHub Inc" - } - }, - "repository": { - "id": 185882436, - "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=", - "name": "hello-world-npm", - "full_name": "Codertocat/hello-world-npm", - "private": true, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/hello-world-npm", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/hello-world-npm", - "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks", - "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events", - "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges", - "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments", - "created_at": "2019-05-09T22:53:26Z", - "updated_at": "2019-05-09T23:24:42Z", - "pushed_at": "2019-05-09T23:27:00Z", - "git_url": "git://github.com/Codertocat/hello-world-npm.git", - "ssh_url": "git@github.com:Codertocat/hello-world-npm.git", - "clone_url": "https://github.com/Codertocat/hello-world-npm.git", - "svn_url": "https://github.com/Codertocat/hello-world-npm", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "published", - "package": { - "id": 10696, - "name": "hello-world-npm", - "namespace": "Codertocat/hello-world", - "description": null, - "ecosystem": "docker", - "package_type": "npm", - "html_url": "https://github.com/Codertocat/hello-world/packages/10696", - "created_at": "2019-05-09T23:28:29Z", - "updated_at": "2019-05-09T23:28:29Z", - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "package_version": { - "id": 57755790, - "version": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "id": 57755790, + "version": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", "description": "Hello-World in a docker container", "summary": "Hello-World in a docker container", @@ -33764,33 +29249,31 @@ }, { "name": "page_build", - "description": "Represents an attempted build of a GitHub Pages site, whether successful or not. A push to a GitHub Pages enabled branch (`gh-pages` for project pages, the default branch for user and organization pages) triggers this event.", + "description": "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](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.\n\n### Availability for `page_build`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `page_build`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`build` object Required\n\nThe [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself.\n\nProperties of `build`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`id` integer Required\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [], "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the page build." - }, "build": { "type": "object", - "description": "The [List GitHub Pages builds](https://docs.github.com/en/rest/reference/pages#list-github-pages-builds) itself." + "description": "The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself." }, - "repository": { + "enterprise": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "An enterprise on GitHub." }, - "organization": { + "id": { "type": "integer", "description": "" }, + "installation": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "installation": { + "organization": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { @@ -33824,152 +29307,6 @@ "created_at": "2019-05-15T15:20:23Z", "updated_at": "2019-05-15T15:20:40Z" }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "id": 130514899, - "build": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pages/builds/130514899", - "status": "built", - "error": { "message": null }, - "pusher": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "commit": "507fc9acd0d04ac4a9db87d12cb228c052cd813a", - "duration": 16984, - "created_at": "2019-05-15T15:20:23Z", - "updated_at": "2019-05-15T15:20:40Z" - }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -34245,177 +29582,52 @@ } ] }, + { + "name": "personal_access_token_request", + "description": "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](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.\n\n### Availability for `personal_access_token_request`\n\n* GitHub Apps\n\n### Webhook payload object for `personal_access_token_request`\n\nAction type: approved\n\nA fine-grained personal access token request was approved.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `approved`\n\n`personal_access_token_request` object Required\n\nDetails of a Personal Access Token Request.\n\nProperties of `personal_access_token_request`\n\n`organization` object Required\n\nA GitHub organization.\n\n`sender` object Required\n\nA GitHub user.\n\n`installation` object Required\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.", + "properties": { + "personal_access_token_request": { + "type": "object", + "description": "Details of a Personal Access Token Request." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + } + }, + "actions": ["approved"], + "examples": [] + }, { "name": "ping", - "description": "When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the [Events API](https://docs.github.com/en/rest/reference/activity#ping-a-repository-webhook) endpoint.", + "description": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.\n\n### Availability for `ping`\n\n* Repositories\n* Organizations\n* GitHub Apps\n* Enterprises\n* GitHub Marketplace\n\n### Webhook payload object for `ping`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`hook` object\n\nThe webhook that is being pinged\n\nProperties of `hook`\n\n`hook_id` integer\n\nThe ID of the webhook that triggered the ping.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.\n\n`zen` string\n\nRandom string of GitHub zen.", "actions": [], "properties": { - "zen": { - "type": "string", - "description": "Random string of GitHub zen." + "hook": { + "type": "object", + "description": "The webhook that is being pinged" }, "hook_id": { "type": "integer", "description": "The ID of the webhook that triggered the ping." }, - "hook": { + "organization": { "type": "object", - "description": "The [webhook configuration](https://docs.github.com/en/rest/reference/webhooks#get-a-repository-webhook)." - }, - "hook[app_id]": { - "type": "integer", - "description": "When you register a new GitHub App, GitHub sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](https://docs.github.com/en/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps) an app." + "description": "A GitHub organization." }, "repository": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." }, + "zen": { "type": "string", "description": "Random string of GitHub zen." } }, "examples": [ - { - "zen": "Anything added dilutes everything else.", - "hook_id": 109948940, - "hook": { - "type": "Repository", - "id": 109948940, - "name": "web", - "active": true, - "events": ["*"], - "config": { - "content_type": "json", - "url": "https://smee.io/****************", - "insecure_ssl": "0" - }, - "updated_at": "2019-05-15T15:20:49Z", - "created_at": "2019-05-15T15:20:49Z", - "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940", - "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test", - "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings", - "last_response": { "code": null, "status": "unused", "message": null } - }, - "repository": { - "id": 186853261, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", - "name": "Hello-World", - "full_name": "Octocoders/Hello-World", - "private": false, - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/Octocoders/Hello-World", - "description": null, - "fork": true, - "url": "https://api.github.com/repos/Octocoders/Hello-World", - "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", - "created_at": "2019-05-15T15:20:42Z", - "updated_at": "2019-05-15T15:20:45Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Octocoders/Hello-World.git", - "ssh_url": "git@github.com:Octocoders/Hello-World.git", - "clone_url": "https://github.com/Octocoders/Hello-World.git", - "svn_url": "https://github.com/Octocoders/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": false, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "zen": "Anything added dilutes everything else.", "hook_id": 109948940, @@ -34773,57 +29985,42 @@ ] }, { - "name": "project", - "description": "Activity related to classic projects. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[projects](https://docs.github.com/en/rest/reference/projects)\" REST API.", - "actions": ["closed", "created", "deleted", "edited", "reopened"], + "name": "project_card", + "description": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.\n\n### Availability for `project_card`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `project_card`\n\nAction type: converted\n\nA note in a classic project was converted to an issue.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `converted`\n\n`changes` object Required\n\nProperties of `changes`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`project_card` object Required\n\nProperties of `project_card`\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["converted", "created", "deleted", "moved"], "properties": { - "changes": { + "changes": { "type": "object", "description": "" }, + "enterprise": { "type": "object", - "description": "The changes to the project if the action was `edited`." + "description": "An enterprise on GitHub." }, - "changes[name][from]": { - "type": "string", - "description": "The previous version of the name if the action was `edited`." - }, - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." - }, - "project": { - "type": "object", - "description": "The [project](https://docs.github.com/en/rest/reference/projects) itself." - }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "project_card": { "type": "object", "description": "" }, + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { "action": "created", - "project": { - "owner_url": "https://api.github.com/repos/Codertocat/Hello-World", - "url": "https://api.github.com/projects/2640902", - "html_url": "https://github.com/Codertocat/Hello-World/projects/1", - "columns_url": "https://api.github.com/projects/2640902/columns", - "id": 2640902, - "node_id": "MDc6UHJvamVjdDI2NDA5MDI=", - "name": "Space 2.0", - "body": "Project tasks for a trip to Space", - "number": 1, - "state": "open", + "project_card": { + "url": "https://api.github.com/projects/columns/cards/21567453", + "project_url": "https://api.github.com/projects/2640902", + "column_url": "https://api.github.com/projects/columns/5368157", + "column_id": 5368157, + "id": 21567453, + "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", + "note": "Work that can be completed in one hour or less.", + "archived": false, "creator": { "login": "Codertocat", "id": 21031067, @@ -34844,8 +30041,9 @@ "type": "User", "site_admin": false }, - "created_at": "2019-05-15T15:21:06Z", - "updated_at": "2019-05-15T15:21:06Z" + "created_at": "2019-05-15T15:21:10Z", + "updated_at": "2019-05-15T15:21:10Z", + "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1" }, "repository": { "id": 186853002, @@ -34939,7 +30137,11 @@ "forks": 1, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -34964,17 +30166,15 @@ }, { "action": "created", - "project": { - "owner_url": "https://api.github.com/repos/Codertocat/Hello-World", - "url": "https://api.github.com/projects/2640902", - "html_url": "https://github.com/Codertocat/Hello-World/projects/1", - "columns_url": "https://api.github.com/projects/2640902/columns", - "id": 2640902, - "node_id": "MDc6UHJvamVjdDI2NDA5MDI=", - "name": "Space 2.0", - "body": "Project tasks for a trip to Space", - "number": 1, - "state": "open", + "project_card": { + "url": "https://api.github.com/projects/columns/cards/21567453", + "project_url": "https://api.github.com/projects/2640902", + "column_url": "https://api.github.com/projects/columns/5368157", + "column_id": 5368157, + "id": 21567453, + "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", + "note": "Work that can be completed in one hour or less.", + "archived": false, "creator": { "login": "Codertocat", "id": 21031067, @@ -34995,8 +30195,9 @@ "type": "User", "site_admin": false }, - "created_at": "2019-05-15T15:21:06Z", - "updated_at": "2019-05-15T15:21:06Z" + "created_at": "2019-05-15T15:21:10Z", + "updated_at": "2019-05-15T15:21:10Z", + "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1" }, "repository": { "id": 186853002, @@ -35115,21 +30316,23 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { "action": "created", - "project": { - "owner_url": "https://api.github.com/repos/Codertocat/Hello-World", - "url": "https://api.github.com/projects/2640902", - "html_url": "https://github.com/Codertocat/Hello-World/projects/1", - "columns_url": "https://api.github.com/projects/2640902/columns", - "id": 2640902, - "node_id": "MDc6UHJvamVjdDI2NDA5MDI=", - "name": "Space 2.0", - "body": "Project tasks for a trip to Space", - "number": 1, - "state": "open", + "project_card": { + "url": "https://api.github.com/projects/columns/cards/21567453", + "project_url": "https://api.github.com/projects/2640902", + "column_url": "https://api.github.com/projects/columns/5368157", + "column_id": 5368157, + "id": 21567453, + "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", + "note": null, + "archived": false, "creator": { "login": "Codertocat", "id": 21031067, @@ -35150,8 +30353,9 @@ "type": "User", "site_admin": false }, - "created_at": "2019-05-15T15:21:06Z", - "updated_at": "2019-05-15T15:21:06Z" + "created_at": "2019-05-15T15:21:10Z", + "updated_at": "2019-05-15T15:21:10Z", + "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1" }, "repository": { "id": 186853002, @@ -35251,200 +30455,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } - } - ] - }, - { - "name": "project_card", - "description": "Activity related to cards in a classic project. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project cards](https://docs.github.com/en/rest/reference/projects#cards)\" REST API.", - "actions": ["converted", "created", "deleted", "edited", "moved"], - "properties": { - "changes": { - "type": "object", - "description": "The changes to the project card if the action was `edited` or `converted`." - }, - "changes[note][from]": { - "type": "string", - "description": "The previous version of the note if the action was `edited` or `converted`." - }, - "after_id": { - "type": "integer", - "description": "The id of the card that this card now follows if the action was \"moved\". Will be `null` if it is the first card in a column." - }, - "project_card": { - "type": "object", - "description": "The [project card](https://docs.github.com/en/rest/reference/projects#cards) itself." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "created", - "project_card": { - "url": "https://api.github.com/projects/columns/cards/21567453", - "project_url": "https://api.github.com/projects/2640902", - "column_url": "https://api.github.com/projects/columns/5368157", - "column_id": 5368157, - "id": 21567453, - "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", - "note": "Work that can be completed in one hour or less.", - "archived": false, - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2019-05-15T15:21:10Z", - "updated_at": "2019-05-15T15:21:10Z" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -35599,6 +30609,20 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -35621,7 +30645,7 @@ } }, { - "action": "created", + "action": "deleted", "project_card": { "url": "https://api.github.com/projects/columns/cards/21567453", "project_url": "https://api.github.com/projects/2640902", @@ -35772,14 +30796,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "created", + "action": "deleted", "project_card": { "url": "https://api.github.com/projects/columns/cards/21567453", "project_url": "https://api.github.com/projects/2640902", @@ -35787,7 +30807,7 @@ "column_id": 5368157, "id": 21567453, "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", - "note": null, + "note": "Work that can be completed in one hour or less.", "archived": false, "creator": { "login": "Codertocat", @@ -35930,10 +30950,14 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "created", + "action": "deleted", "project_card": { "url": "https://api.github.com/projects/columns/cards/21567453", "project_url": "https://api.github.com/projects/2640902", @@ -36101,7 +31125,8 @@ } }, { - "action": "deleted", + "action": "moved", + "changes": { "column_id": { "from": 9999467 } }, "project_card": { "url": "https://api.github.com/projects/columns/cards/21567453", "project_url": "https://api.github.com/projects/2640902", @@ -36133,7 +31158,8 @@ }, "created_at": "2019-05-15T15:21:10Z", "updated_at": "2019-05-15T15:21:10Z", - "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1" + "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1", + "after_id": null }, "repository": { "id": 186853002, @@ -36253,18 +31279,47 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "project", + "description": "This event occurs when there is activity relating to a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.\n\n### Availability for `project`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `project`\n\nAction type: closed\n\nA classic project was closed.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `closed`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`project` object Required\n\nProperties of `project`\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["closed", "created"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, + "project": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "deleted", - "project_card": { - "url": "https://api.github.com/projects/columns/cards/21567453", - "project_url": "https://api.github.com/projects/2640902", - "column_url": "https://api.github.com/projects/columns/5368157", - "column_id": 5368157, - "id": 21567453, - "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", - "note": "Work that can be completed in one hour or less.", - "archived": false, + "action": "created", + "project": { + "owner_url": "https://api.github.com/repos/Codertocat/Hello-World", + "url": "https://api.github.com/projects/2640902", + "html_url": "https://github.com/Codertocat/Hello-World/projects/1", + "columns_url": "https://api.github.com/projects/2640902/columns", + "id": 2640902, + "node_id": "MDc6UHJvamVjdDI2NDA5MDI=", + "name": "Space 2.0", + "body": "Project tasks for a trip to Space", + "number": 1, + "state": "open", "creator": { "login": "Codertocat", "id": 21031067, @@ -36285,9 +31340,8 @@ "type": "User", "site_admin": false }, - "created_at": "2019-05-15T15:21:10Z", - "updated_at": "2019-05-15T15:21:10Z", - "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1" + "created_at": "2019-05-15T15:21:06Z", + "updated_at": "2019-05-15T15:21:06Z" }, "repository": { "id": 186853002, @@ -36406,23 +31460,21 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "deleted", - "project_card": { - "url": "https://api.github.com/projects/columns/cards/21567453", - "project_url": "https://api.github.com/projects/2640902", - "column_url": "https://api.github.com/projects/columns/5368157", - "column_id": 5368157, - "id": 21567453, - "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", - "note": "Work that can be completed in one hour or less.", - "archived": false, + "action": "created", + "project": { + "owner_url": "https://api.github.com/repos/Codertocat/Hello-World", + "url": "https://api.github.com/projects/2640902", + "html_url": "https://github.com/Codertocat/Hello-World/projects/1", + "columns_url": "https://api.github.com/projects/2640902/columns", + "id": 2640902, + "node_id": "MDc6UHJvamVjdDI2NDA5MDI=", + "name": "Space 2.0", + "body": "Project tasks for a trip to Space", + "number": 1, + "state": "open", "creator": { "login": "Codertocat", "id": 21031067, @@ -36443,9 +31495,8 @@ "type": "User", "site_admin": false }, - "created_at": "2019-05-15T15:21:10Z", - "updated_at": "2019-05-15T15:21:10Z", - "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1" + "created_at": "2019-05-15T15:21:06Z", + "updated_at": "2019-05-15T15:21:06Z" }, "repository": { "id": 186853002, @@ -36545,20 +31596,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -36578,44 +31615,50 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "project_column", + "description": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.\n\n### Availability for `project_column`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `project_column`\n\nAction type: created\n\nA column was added to a classic project.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`project_column` object Required\n\nProperties of `project_column`\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.", + "actions": ["created", "edited"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "project_column": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "moved", - "changes": { "column_id": { "from": 9999467 } }, - "project_card": { - "url": "https://api.github.com/projects/columns/cards/21567453", + "action": "created", + "project_column": { + "url": "https://api.github.com/projects/columns/5368157", "project_url": "https://api.github.com/projects/2640902", - "column_url": "https://api.github.com/projects/columns/5368157", - "column_id": 5368157, - "id": 21567453, - "node_id": "MDExOlByb2plY3RDYXJkMjE1Njc0NTM=", - "note": "Work that can be completed in one hour or less.", - "archived": false, - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2019-05-15T15:21:10Z", - "updated_at": "2019-05-15T15:21:10Z", - "content_url": "https://api.github.com/repos/Codertocat/Hello-Worls/issues/1", - "after_id": null + "cards_url": "https://api.github.com/projects/columns/5368157/cards", + "id": 5368157, + "node_id": "MDEzOlByb2plY3RDb2x1bW41MzY4MTU3", + "name": "Small bugfixes", + "created_at": "2019-05-15T15:21:09Z", + "updated_at": "2019-05-15T15:21:09Z" }, "repository": { "id": 186853002, @@ -36735,48 +31778,7 @@ "type": "User", "site_admin": false } - } - ] - }, - { - "name": "project_column", - "description": "Activity related to columns in a classic project. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project columns](https://docs.github.com/en/rest/reference/projects#columns)\" REST API.", - "actions": ["created", "deleted", "edited", "moved"], - "properties": { - "changes": { - "type": "object", - "description": "The changes to the project column if the action was `edited`." - }, - "changes[name][from]": { - "type": "string", - "description": "The previous version of the name if the action was `edited`." - }, - "after_id": { - "type": "integer", - "description": "The id of the column that this column now follows if the action was \"moved\". Will be `null` if it is the first column in a project." }, - "project_column": { - "type": "object", - "description": "The [project column](https://docs.github.com/en/rest/reference/projects#columns) itself." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ { "action": "created", "project_column": { @@ -36881,7 +31883,11 @@ "forks": 1, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -36902,10 +31908,15 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "created", + "action": "edited", + "changes": { "name": { "from": "" } }, "project_column": { "url": "https://api.github.com/projects/columns/5368157", "project_url": "https://api.github.com/projects/2640902", @@ -37034,26 +32045,137 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "projects_v2", + "description": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).\n\n### Availability for `projects_v2`\n\n* Organizations\n\n### Webhook payload object for `projects_v2`\n\nAction type: closed\n\nA project in the organization was closed.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `closed`\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object Required\n\nA GitHub organization.\n\n`projects_v2` object Required\n\nA projects v2 project\n\nProperties of `projects_v2`\n\n`sender` object Required\n\nA GitHub user.", + "properties": { + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "projects_v2": { + "type": "object", + "description": "A projects v2 project" }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "actions": ["closed"], + "examples": [] + }, + { + "name": "projects_v2_item", + "description": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).\n\n### Availability for `projects_v2_item`\n\n* Organizations\n\n### Webhook payload object for `projects_v2_item`\n\nAction type: archived\n\nAn item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `archived`\n\n`changes` object Required\n\nProperties of `changes`\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object Required\n\nA GitHub organization.\n\n`projects_v2_item` object Required\n\nAn item belonging to a project\n\nProperties of `projects_v2_item`\n\n`sender` object Required\n\nA GitHub user.", + "actions": [ + "archived", + "converted", + "created", + "edited", + "reordered", + "restored" + ], + "properties": { + "changes": { "type": "object", "description": "" }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "projects_v2_item": { + "type": "object", + "description": "An item belonging to a project" + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "created", - "project_column": { - "url": "https://api.github.com/projects/columns/5368157", - "project_url": "https://api.github.com/projects/2640902", - "cards_url": "https://api.github.com/projects/columns/5368157/cards", - "id": 5368157, - "node_id": "MDEzOlByb2plY3RDb2x1bW41MzY4MTU3", - "name": "Small bugfixes", - "created_at": "2019-05-15T15:21:09Z", - "updated_at": "2019-05-15T15:21:09Z" + "action": "archived", + "projects_v2_item": { + "id": 5679898, + "node_id": "PVTI_lADOAWcTxs4ACgDdzgBWqxo", + "project_node_id": "PVT_kwDOAWcTxs4ACgDd", + "content_node_id": "I_kwDOCG5vGM5La0aB", + "content_type": "Issue", + "creator": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-06-08T21:14:07Z", + "updated_at": "2022-06-08T21:19:35Z", + "archived_at": "2022-06-08T21:19:35Z" }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { + "changes": { + "archived_at": { "from": null, "to": "2022-06-08T17:19:35-04:00" } + }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "action": "converted", + "projects_v2_item": { + "id": 5679898, + "node_id": "PVTI_lADOAWcTxs4ACgDdzgBWqxo", + "project_node_id": "PVT_kwDOAWcTxs4ACgDd", + "content_node_id": "I_kwDOCG5vGM5La0aB", + "content_type": "Issue", + "creator": { "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -37073,455 +32195,24 @@ "type": "User", "site_admin": false }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } - }, - { - "action": "edited", - "changes": { "name": { "from": "" } }, - "project_column": { - "url": "https://api.github.com/projects/columns/5368157", - "project_url": "https://api.github.com/projects/2640902", - "cards_url": "https://api.github.com/projects/columns/5368157/cards", - "id": 5368157, - "node_id": "MDEzOlByb2plY3RDb2x1bW41MzY4MTU3", - "name": "Small bugfixes", - "created_at": "2019-05-15T15:21:09Z", - "updated_at": "2019-05-15T15:21:09Z" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "projects_v2_item", - "description": "Activity related to items in a project. The type of activity is specified in the `action` property of the payload object. For more information, see \"[About projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"", - "actions": [ - "archived", - "converted", - "created", - "deleted", - "edited", - "reordered", - "restored" - ], - "properties": { - "projects_v2_item": { - "type": "object", - "description": "The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see \"[Using the API to manage projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects).\"" - }, - "changes": { - "type": "object", - "description": "The changes to the project item." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "created", - "projects_v2_item": { - "id": 15, - "node_id": "PVTI_lAAEAQ8", - "project_node_id": "PVT_kwAEAQ", - "content_node_id": "DI_lAAEAQo", - "content_type": "DraftIssue", - "creator": { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "http://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "http://api.github.com/users/monalisa", - "html_url": "http://github.com/monalisa", - "followers_url": "http://api.github.com/users/monalisa/followers", - "following_url": "http://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "http://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "http://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "http://api.github.com/users/monalisa/subscriptions", - "organizations_url": "http://api.github.com/users/monalisa/orgs", - "repos_url": "http://api.github.com/users/monalisa/repos", - "events_url": "http://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "http://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "created_at": "2022-05-20T21:20:57Z", - "updated_at": "2022-05-20T21:20:57Z", - "archived_at": null - }, - "organization": { - "login": "github", - "id": 4, - "node_id": "O_kgAE", - "url": "http://api.github.com/orgs/github", - "repos_url": "http://api.github.com/orgs/github/repos", - "events_url": "http://api.github.com/orgs/github/events", - "hooks_url": "http://api.github.com/orgs/github/hooks", - "issues_url": "http://api.github.com/orgs/github/issues", - "members_url": "http://api.github.com/orgs/github/members{/member}", - "public_members_url": "http://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "http://alambic.github.com/avatars/u/4?", - "description": null - }, - "sender": { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "http://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "http://api.github.com/users/monalisa", - "html_url": "http://github.com/monalisa", - "followers_url": "http://api.github.com/users/monalisa/followers", - "following_url": "http://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "http://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "http://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "http://api.github.com/users/monalisa/subscriptions", - "organizations_url": "http://api.github.com/users/monalisa/orgs", - "repos_url": "http://api.github.com/users/monalisa/repos", - "events_url": "http://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "http://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - } - }, - { - "action": "archived", - "projects_v2_item": { - "id": 5679898, - "node_id": "PVTI_lADOAWcTxs4ACgDdzgBWqxo", - "project_node_id": "PVT_kwDOAWcTxs4ACgDd", - "content_node_id": "I_kwDOCG5vGM5La0aB", - "content_type": "Issue", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-06-08T21:14:07Z", - "updated_at": "2022-06-08T21:19:35Z", - "archived_at": "2022-06-08T21:19:35Z" - }, - "changes": { - "archived_at": { "from": null, "to": "2022-06-08T17:19:35-04:00" } - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "converted", - "projects_v2_item": { - "id": 5679898, - "node_id": "PVTI_lADOAWcTxs4ACgDdzgBWqxo", - "project_node_id": "PVT_kwDOAWcTxs4ACgDd", - "content_node_id": "I_kwDOCG5vGM5La0aB", - "content_type": "Issue", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-06-08T21:14:07Z", - "updated_at": "2022-06-08T21:14:17Z", - "archived_at": null - }, - "changes": { "content_type": { "from": "DraftIssue", "to": "Issue" } }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" + "created_at": "2022-06-08T21:14:07Z", + "updated_at": "2022-06-08T21:14:17Z", + "archived_at": null + }, + "changes": { "content_type": { "from": "DraftIssue", "to": "Issue" } }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" }, "sender": { "login": "Codertocat", @@ -37843,143 +32534,28 @@ }, { "name": "public", - "description": "When a private repository is made public. Without a doubt: the best GitHub event.", + "description": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\n\n### Availability for `public`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `public`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [], "properties": { - "repository": { + "enterprise": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "An enterprise on GitHub." }, - "organization": { + "installation": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "installation": { + "organization": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "repository": { "id": 186853002, @@ -38228,19 +32804,13 @@ }, { "name": "pull_request", - "description": "Activity related to pull requests. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[pull requests](https://docs.github.com/en/rest/reference/pulls)\" REST API.", + "description": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\n\n### Availability for `pull_request`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `pull_request`\n\nAction type: assigned\n\nA pull request was assigned to a user.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `assigned`\n\n`assignee` object or null Required\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`number` integer Required\n\nThe pull request number.\n\n`organization` object\n\nA GitHub organization.\n\n`pull_request` object Required\n\nProperties of `pull_request`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": [ "assigned", - "auto_merge_disabled", - "auto_merge_enabled", "closed", "converted_to_draft", - "dequeued", - "edited", - "enqueued", "labeled", "locked", - "merged", "opened", "ready_for_review", "reopened", @@ -38252,50 +32822,33 @@ "unlocked" ], "properties": { - "number": { - "type": "integer", - "description": "The pull request number." - }, - "changes": { + "assignee": { "type": "object or null", "description": "" }, + "enterprise": { "type": "object", - "description": "The changes to the comment if the action was `edited`." - }, - "changes[title][from]": { - "type": "string", - "description": "The previous version of the title if the action was `edited`." + "description": "An enterprise on GitHub." }, - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." - }, - "pull_request": { + "installation": { "type": "object", - "description": "The [pull request](https://docs.github.com/en/rest/reference/pulls) itself." - }, - "reason": { - "type": "string", - "description": "The reason the pull request was removed from a merge queue if the action was `dequeued`." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "number": { + "type": "integer", + "description": "The pull request number." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { + "pull_request": { "type": "object", "description": "" }, + "repository": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { - "action": "opened", + "action": "assigned", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -38334,23 +32887,10 @@ "updated_at": "2019-05-15T15:20:33Z", "closed_at": null, "merged_at": null, - "merge_commit_sha": null, + "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", "assignee": null, - "assignees": [], - "requested_reviewers": [], - "requested_teams": [], - "labels": [], - "milestone": null, - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", - "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", - "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "head": { - "label": "Codertocat:changes", - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { + "assignees": [ + { "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -38369,23 +32909,88 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + } + ], + "requested_reviewers": [ + { + "login": "octocat", + "id": 5346, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "http://alambic.github.com/avatars/u/5346?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "http://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 1362934389, + "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", + "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", + "color": "d73a4a", + "default": true, + "description": "Something isn't working" + } + ], + "milestone": null, + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "head": { + "label": "Codertocat:changes", + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "user": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", @@ -38437,8 +33042,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -38447,7 +33052,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -38463,10 +33068,10 @@ "open_issues": 2, "watchers": 0, "default_branch": "master", - "allow_squash_merge": true, - "allow_merge_commit": true, - "allow_rebase_merge": true, - "delete_branch_on_merge": false + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false } }, "base": { @@ -38560,8 +33165,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -38570,7 +33175,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -38586,10 +33191,10 @@ "open_issues": 2, "watchers": 0, "default_branch": "master", - "allow_squash_merge": true, - "allow_merge_commit": true, - "allow_rebase_merge": true, - "delete_branch_on_merge": false + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false } }, "_links": { @@ -38619,11 +33224,13 @@ } }, "author_association": "OWNER", + "auto_merge": null, + "active_lock_reason": null, "draft": false, "merged": false, - "mergeable": null, - "rebaseable": null, - "mergeable_state": "unknown", + "mergeable": true, + "rebaseable": true, + "mergeable_state": "clean", "merged_by": null, "comments": 0, "review_comments": 0, @@ -38633,6 +33240,26 @@ "deletions": 1, "changed_files": 1 }, + "assignee": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -38700,8 +33327,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -38710,7 +33337,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -38725,7 +33352,15 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, "sender": { "login": "Codertocat", @@ -39161,6 +33796,20 @@ "type": "User", "site_admin": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -39285,7 +33934,7 @@ } }, { - "action": "assigned", + "action": "closed", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -39296,7 +33945,7 @@ "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", "number": 2, - "state": "open", + "state": "closed", "locked": false, "title": "Update the README with new information.", "user": { @@ -39321,8 +33970,8 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:33Z", - "closed_at": null, + "updated_at": "2019-05-15T15:21:18Z", + "closed_at": "2019-05-15T15:21:18Z", "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", "assignee": null, @@ -39479,8 +34128,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:21:14Z", + "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -39499,10 +34148,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -39602,8 +34251,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:21:14Z", + "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -39622,10 +34271,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -39670,47 +34319,13 @@ "mergeable_state": "clean", "merged_by": null, "comments": 0, - "review_comments": 0, + "review_comments": 1, "maintainer_can_modify": false, "commits": 1, "additions": 1, "deletions": 1, "changed_files": 1 }, - "assignee": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -39778,8 +34393,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:21:14Z", + "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -39798,10 +34413,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -40329,6 +34944,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -40351,7 +34980,7 @@ } }, { - "action": "closed", + "action": "converted_to_draft", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -40362,7 +34991,7 @@ "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", "number": 2, - "state": "closed", + "state": "open", "locked": false, "title": "Update the README with new information.", "user": { @@ -40388,9 +35017,9 @@ "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", "updated_at": "2019-05-15T15:21:18Z", - "closed_at": "2019-05-15T15:21:18Z", + "closed_at": null, "merged_at": null, - "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", + "merge_commit_sha": null, "assignee": null, "assignees": [ { @@ -40729,7 +35358,7 @@ "author_association": "OWNER", "auto_merge": null, "active_lock_reason": null, - "draft": false, + "draft": true, "merged": false, "mergeable": true, "rebaseable": true, @@ -40841,24 +35470,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -41390,6 +36001,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { @@ -41883,6 +36498,20 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "hellomouse", + "id": 23532486, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjIzNTMyNDg2", + "url": "https://api.github.com/orgs/hellomouse", + "repos_url": "https://api.github.com/orgs/hellomouse/repos", + "events_url": "https://api.github.com/orgs/hellomouse/events", + "hooks_url": "https://api.github.com/orgs/hellomouse/hooks", + "issues_url": "https://api.github.com/orgs/hellomouse/issues", + "members_url": "https://api.github.com/orgs/hellomouse/members{/member}", + "public_members_url": "https://api.github.com/orgs/hellomouse/public_members{/member}", + "avatar_url": "https://avatars0.githubusercontent.com/u/23532486?v=4", + "description": "we totally know what we're doing" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -41902,14 +36531,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "converted_to_draft", + "action": "labeled", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -41945,11 +36570,30 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:21:18Z", + "updated_at": "2019-05-15T15:20:35Z", "closed_at": null, "merged_at": null, - "merge_commit_sha": null, - "assignee": null, + "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", + "assignee": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, "assignees": [ { "login": "Codertocat", @@ -42006,7 +36650,43 @@ "description": "Something isn't working" } ], - "milestone": null, + "milestone": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", + "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 4317517, + "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", + "number": 1, + "title": "v1.0", + "description": "Add new space flight simulator", + "creator": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 1, + "closed_issues": 0, + "state": "closed", + "created_at": "2019-05-15T15:20:17Z", + "updated_at": "2019-05-15T15:20:35Z", + "due_on": "2019-05-23T07:00:00Z", + "closed_at": "2019-05-15T15:20:18Z" + }, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -42103,8 +36783,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -42123,10 +36803,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 1, + "open_issues_count": 2, "license": null, "forks": 0, - "open_issues": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", "is_template": false, @@ -42226,8 +36906,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -42246,10 +36926,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 1, + "open_issues_count": 2, "license": null, "forks": 0, - "open_issues": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", "is_template": false, @@ -42287,20 +36967,29 @@ "author_association": "OWNER", "auto_merge": null, "active_lock_reason": null, - "draft": true, + "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_by": null, "comments": 0, - "review_comments": 1, + "review_comments": 0, "maintainer_can_modify": false, "commits": 1, "additions": 1, "deletions": 1, "changed_files": 1 }, + "label": { + "id": 1362934389, + "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", + "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", + "color": "d73a4a", + "default": true, + "description": "Something isn't working" + }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -42368,8 +37057,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -42388,10 +37077,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 1, + "open_issues_count": 2, "license": null, "forks": 0, - "open_issues": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", "is_template": false, @@ -42399,19 +37088,9 @@ "visibility": "public", "web_commit_signoff_required": false }, - "organization": { - "login": "hellomouse", - "id": 23532486, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjIzNTMyNDg2", - "url": "https://api.github.com/orgs/hellomouse", - "repos_url": "https://api.github.com/orgs/hellomouse/repos", - "events_url": "https://api.github.com/orgs/hellomouse/events", - "hooks_url": "https://api.github.com/orgs/hellomouse/hooks", - "issues_url": "https://api.github.com/orgs/hellomouse/issues", - "members_url": "https://api.github.com/orgs/hellomouse/members{/member}", - "public_members_url": "https://api.github.com/orgs/hellomouse/public_members{/member}", - "avatar_url": "https://avatars0.githubusercontent.com/u/23532486?v=4", - "description": "we totally know what we're doing" + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, "sender": { "login": "Codertocat", @@ -42993,6 +37672,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -43015,7 +37708,7 @@ } }, { - "action": "labeled", + "action": "locked", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -43027,7 +37720,7 @@ "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", "number": 2, "state": "open", - "locked": false, + "locked": true, "title": "Update the README with new information.", "user": { "login": "Codertocat", @@ -43051,30 +37744,11 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:35Z", + "updated_at": "2019-05-15T15:20:36Z", "closed_at": null, "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", - "assignee": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, + "assignee": null, "assignees": [ { "login": "Codertocat", @@ -43131,43 +37805,7 @@ "description": "Something isn't working" } ], - "milestone": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", - "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", - "id": 4317517, - "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", - "number": 1, - "title": "v1.0", - "description": "Add new space flight simulator", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 1, - "closed_issues": 0, - "state": "closed", - "created_at": "2019-05-15T15:20:17Z", - "updated_at": "2019-05-15T15:20:35Z", - "due_on": "2019-05-23T07:00:00Z", - "closed_at": "2019-05-15T15:20:18Z" - }, + "milestone": null, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -43447,7 +38085,7 @@ }, "author_association": "OWNER", "auto_merge": null, - "active_lock_reason": null, + "active_lock_reason": "off-topic", "draft": false, "merged": false, "mergeable": true, @@ -43462,15 +38100,6 @@ "deletions": 1, "changed_files": 1 }, - "label": { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true, - "description": "Something isn't working" - }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -43573,20 +38202,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -44103,6 +38718,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -44125,7 +38754,7 @@ } }, { - "action": "locked", + "action": "opened", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -44137,7 +38766,7 @@ "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", "number": 2, "state": "open", - "locked": true, + "locked": false, "title": "Update the README with new information.", "user": { "login": "Codertocat", @@ -44161,10 +38790,10 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:36Z", + "updated_at": "2019-05-15T15:20:33Z", "closed_at": null, "merged_at": null, - "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", + "merge_commit_sha": null, "assignee": null, "assignees": [ { @@ -44319,8 +38948,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -44329,7 +38958,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -44442,8 +39071,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -44452,7 +39081,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -44502,12 +39131,12 @@ }, "author_association": "OWNER", "auto_merge": null, - "active_lock_reason": "off-topic", + "active_lock_reason": null, "draft": false, "merged": false, - "mergeable": true, - "rebaseable": true, - "mergeable_state": "clean", + "mergeable": null, + "rebaseable": null, + "mergeable_state": "unknown", "merged_by": null, "comments": 0, "review_comments": 0, @@ -44584,8 +39213,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -44594,7 +39223,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -44619,20 +39248,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -44689,7 +39304,7 @@ "type": "User", "site_admin": false }, - "body": "This is a pretty simple change that we need to pull into master.", + "body": null, "created_at": "2019-05-15T15:20:33Z", "updated_at": "2019-05-15T15:20:33Z", "closed_at": null, @@ -45205,7 +39820,7 @@ "type": "User", "site_admin": false }, - "body": null, + "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", "updated_at": "2019-05-15T15:20:33Z", "closed_at": null, @@ -45665,6 +40280,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -45687,7 +40316,7 @@ } }, { - "action": "opened", + "action": "ready_for_review", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -45723,7 +40352,7 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:21:18Z", "closed_at": null, "merged_at": null, "merge_commit_sha": null, @@ -45881,8 +40510,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:21:14Z", + "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -45891,7 +40520,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -45901,10 +40530,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -46004,8 +40633,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:21:14Z", + "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -46014,7 +40643,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -46024,10 +40653,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -46067,12 +40696,12 @@ "active_lock_reason": null, "draft": false, "merged": false, - "mergeable": null, - "rebaseable": null, - "mergeable_state": "unknown", + "mergeable": true, + "rebaseable": true, + "mergeable_state": "clean", "merged_by": null, "comments": 0, - "review_comments": 0, + "review_comments": 1, "maintainer_can_modify": false, "commits": 1, "additions": 1, @@ -46146,8 +40775,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:21:14Z", + "pushed_at": "2019-05-15T15:20:57Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -46156,7 +40785,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -46166,10 +40795,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 1, "license": null, "forks": 0, - "open_issues": 2, + "open_issues": 1, "watchers": 0, "default_branch": "master", "is_template": false, @@ -46177,24 +40806,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -46726,6 +41337,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { @@ -47219,6 +41834,20 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "hellomouse", + "id": 23532486, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjIzNTMyNDg2", + "url": "https://api.github.com/orgs/hellomouse", + "repos_url": "https://api.github.com/orgs/hellomouse/repos", + "events_url": "https://api.github.com/orgs/hellomouse/events", + "hooks_url": "https://api.github.com/orgs/hellomouse/hooks", + "issues_url": "https://api.github.com/orgs/hellomouse/issues", + "members_url": "https://api.github.com/orgs/hellomouse/members{/member}", + "public_members_url": "https://api.github.com/orgs/hellomouse/public_members{/member}", + "avatar_url": "https://avatars0.githubusercontent.com/u/23532486?v=4", + "description": "we totally know what we're doing" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -47238,14 +41867,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "ready_for_review", + "action": "reopened", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -47281,7 +41906,7 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:21:18Z", + "updated_at": "2019-05-15T15:20:33Z", "closed_at": null, "merged_at": null, "merge_commit_sha": null, @@ -47439,8 +42064,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -47449,7 +42074,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -47459,10 +42084,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 1, + "open_issues_count": 2, "license": null, "forks": 0, - "open_issues": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", "is_template": false, @@ -47562,8 +42187,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -47572,7 +42197,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -47582,10 +42207,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 1, + "open_issues_count": 2, "license": null, "forks": 0, - "open_issues": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", "is_template": false, @@ -47625,12 +42250,12 @@ "active_lock_reason": null, "draft": false, "merged": false, - "mergeable": true, - "rebaseable": true, - "mergeable_state": "clean", + "mergeable": null, + "rebaseable": null, + "mergeable_state": "unknown", "merged_by": null, "comments": 0, - "review_comments": 1, + "review_comments": 0, "maintainer_can_modify": false, "commits": 1, "additions": 1, @@ -47704,8 +42329,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:14Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:19:27Z", + "pushed_at": "2019-05-15T15:20:32Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -47714,7 +42339,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": null, "has_issues": true, "has_projects": true, "has_downloads": true, @@ -47724,10 +42349,10 @@ "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 1, + "open_issues_count": 2, "license": null, "forks": 0, - "open_issues": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", "is_template": false, @@ -47735,19 +42360,9 @@ "visibility": "public", "web_commit_signoff_required": false }, - "organization": { - "login": "hellomouse", - "id": 23532486, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjIzNTMyNDg2", - "url": "https://api.github.com/orgs/hellomouse", - "repos_url": "https://api.github.com/orgs/hellomouse/repos", - "events_url": "https://api.github.com/orgs/hellomouse/events", - "hooks_url": "https://api.github.com/orgs/hellomouse/hooks", - "issues_url": "https://api.github.com/orgs/hellomouse/issues", - "members_url": "https://api.github.com/orgs/hellomouse/members{/member}", - "public_members_url": "https://api.github.com/orgs/hellomouse/public_members{/member}", - "avatar_url": "https://avatars0.githubusercontent.com/u/23532486?v=4", - "description": "we totally know what we're doing" + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, "sender": { "login": "Codertocat", @@ -48265,6 +42880,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -48287,7 +42916,7 @@ } }, { - "action": "reopened", + "action": "review_request_removed", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -48814,10 +43443,30 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "requested_reviewer": { + "login": "octocat", + "id": 5346, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "http://alambic.github.com/avatars/u/5346?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "http://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false } }, { - "action": "review_request_removed", + "action": "review_requested", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -49367,7 +44016,7 @@ } }, { - "action": "review_requested", + "action": "synchronize", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -49759,6 +44408,8 @@ "deletions": 1, "changed_files": 1 }, + "before": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -49861,20 +44512,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -49894,30 +44531,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "requested_reviewer": { - "login": "octocat", - "id": 5346, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "http://alambic.github.com/avatars/u/5346?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "http://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false } }, { - "action": "synchronize", + "action": "unassigned", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -49953,11 +44570,30 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:33Z", + "updated_at": "2019-05-15T15:20:35Z", "closed_at": null, "merged_at": null, - "merge_commit_sha": null, - "assignee": null, + "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", + "assignee": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, "assignees": [ { "login": "Codertocat", @@ -49980,28 +44616,7 @@ "site_admin": false } ], - "requested_reviewers": [ - { - "login": "octocat", - "id": 5346, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "http://alambic.github.com/avatars/u/5346?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "http://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], + "requested_reviewers": [], "requested_teams": [], "labels": [ { @@ -50014,7 +44629,43 @@ "description": "Something isn't working" } ], - "milestone": null, + "milestone": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", + "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", + "id": 4317517, + "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", + "number": 1, + "title": "v1.0", + "description": "Add new space flight simulator", + "creator": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 1, + "closed_issues": 0, + "state": "closed", + "created_at": "2019-05-15T15:20:17Z", + "updated_at": "2019-05-15T15:20:35Z", + "due_on": "2019-05-23T07:00:00Z", + "closed_at": "2019-05-15T15:20:18Z" + }, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -50111,8 +44762,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -50121,7 +44772,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -50234,8 +44885,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -50244,7 +44895,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -50297,9 +44948,9 @@ "active_lock_reason": null, "draft": false, "merged": false, - "mergeable": null, - "rebaseable": null, - "mergeable_state": "unknown", + "mergeable": true, + "rebaseable": true, + "mergeable_state": "clean", "merged_by": null, "comments": 0, "review_comments": 0, @@ -50309,8 +44960,26 @@ "deletions": 1, "changed_files": 1 }, - "before": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "assignee": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -50378,8 +45047,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -50388,7 +45057,7 @@ "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "Ruby", "has_issues": true, "has_projects": true, "has_downloads": true, @@ -50983,6 +45652,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -51005,7 +45688,7 @@ } }, { - "action": "unassigned", + "action": "unlabeled", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -51041,30 +45724,11 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:35Z", + "updated_at": "2019-05-15T15:20:36Z", "closed_at": null, "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", - "assignee": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, + "assignee": null, "assignees": [ { "login": "Codertocat", @@ -51100,43 +45764,7 @@ "description": "Something isn't working" } ], - "milestone": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1", - "html_url": "https://github.com/Codertocat/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones/1/labels", - "id": 4317517, - "node_id": "MDk6TWlsZXN0b25lNDMxNzUxNw==", - "number": 1, - "title": "v1.0", - "description": "Add new space flight simulator", - "creator": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 1, - "closed_issues": 0, - "state": "closed", - "created_at": "2019-05-15T15:20:17Z", - "updated_at": "2019-05-15T15:20:35Z", - "due_on": "2019-05-23T07:00:00Z", - "closed_at": "2019-05-15T15:20:18Z" - }, + "milestone": null, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -51431,25 +46059,14 @@ "deletions": 1, "changed_files": 1 }, - "assignee": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false + "label": { + "id": 1362934389, + "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", + "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", + "color": "d73a4a", + "default": true, + "description": "Something isn't working" }, "repository": { "id": 186853002, @@ -51553,20 +46170,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -52071,6 +46674,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -52093,7 +46710,7 @@ } }, { - "action": "unlabeled", + "action": "unlocked", "number": 2, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -52129,7 +46746,7 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:36Z", + "updated_at": "2019-05-15T15:20:37Z", "closed_at": null, "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", @@ -52464,15 +47081,6 @@ "deletions": 1, "changed_files": 1 }, - "label": { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true, - "description": "Something isn't working" - }, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -52575,20 +47183,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -53084,6 +47678,20 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -53104,10 +47712,107 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "pull_request_review_comment", + "description": "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](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\n\n### Availability for `pull_request_review_comment`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `pull_request_review_comment`\n\nAction type: created\n\nA comment on a pull request diff was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`comment` object Required\n\nThe [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.\n\nProperties of `comment`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`pull_request` object Required\n\nProperties of `pull_request`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["created", "deleted", "edited"], + "properties": { + "comment": { + "type": "object", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself." }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "pull_request": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "unlocked", - "number": 2, + "action": "created", + "comment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", + "pull_request_review_id": 237895671, + "id": 284312630, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", + "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", + "path": "README.md", + "position": 1, + "original_position": 1, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "user": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Maybe you should use more emojji on this line.", + "created_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", + "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", + "_links": { + "self": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" + }, + "html": { + "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" + }, + "pull_request": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" + } + }, + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 265, + "original_line": 265, + "side": "RIGHT" + }, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "id": 279147437, @@ -53142,7 +47847,7 @@ }, "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", "closed_at": null, "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", @@ -53169,7 +47874,28 @@ "site_admin": false } ], - "requested_reviewers": [], + "requested_reviewers": [ + { + "login": "octocat", + "id": 5346, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "http://alambic.github.com/avatars/u/5346?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "http://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], "requested_teams": [], "labels": [ { @@ -53461,21 +48187,7 @@ } }, "author_association": "OWNER", - "auto_merge": null, - "active_lock_reason": null, - "draft": false, - "merged": false, - "mergeable": true, - "rebaseable": true, - "mergeable_state": "clean", - "merged_by": null, - "comments": 0, - "review_comments": 0, - "maintainer_can_modify": false, - "commits": 1, - "additions": 1, - "deletions": 1, - "changed_files": 1 + "active_lock_reason": null }, "repository": { "id": 186853002, @@ -53579,20 +48291,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -53613,49 +48311,20 @@ "type": "User", "site_admin": false } - } - ] - }, - { - "name": "pull_request_review", - "description": "Activity related to pull request reviews. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[pull request reviews](https://docs.github.com/en/rest/reference/pulls#reviews)\" REST API.", - "actions": ["dismissed", "edited", "submitted"], - "properties": { - "pull_request": { - "type": "object", - "description": "The [pull request](https://docs.github.com/en/rest/reference/pulls) the review pertains to." - }, - "review": { - "type": "object", - "description": "The review that was affected." - }, - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ { - "action": "submitted", - "review": { - "id": 237895671, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx", + "action": "created", + "comment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", + "pull_request_review_id": 237895671, + "id": 284312630, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", + "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", + "path": "README.md", + "position": 1, + "original_position": 1, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "user": { "login": "Codertocat", "id": 21031067, @@ -53676,21 +48345,41 @@ "type": "User", "site_admin": false }, - "body": null, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "submitted_at": "2019-05-15T15:20:38Z", - "state": "commented", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671", + "body": "Maybe you should use more emojji on this line.", + "created_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "author_association": "OWNER", "_links": { + "self": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" + }, "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671" + "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" }, "pull_request": { "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" } - } + }, + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 265, + "original_line": 265, + "side": "RIGHT" }, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -53731,10 +48420,62 @@ "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", "assignee": null, - "assignees": [], - "requested_reviewers": [], + "assignees": [ + { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "octocat", + "id": 5346, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "http://alambic.github.com/avatars/u/5346?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "http://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], "requested_teams": [], - "labels": [], + "labels": [ + { + "id": 1362934389, + "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", + "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", + "color": "d73a4a", + "default": true, + "description": "Something isn't working" + } + ], "milestone": null, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", @@ -53858,10 +48599,10 @@ "open_issues": 2, "watchers": 0, "default_branch": "master", - "allow_squash_merge": true, - "allow_merge_commit": true, - "allow_rebase_merge": true, - "delete_branch_on_merge": false + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false } }, "base": { @@ -53981,10 +48722,10 @@ "open_issues": 2, "watchers": 0, "default_branch": "master", - "allow_squash_merge": true, - "allow_merge_commit": true, - "allow_rebase_merge": true, - "delete_branch_on_merge": false + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false } }, "_links": { @@ -54013,7 +48754,8 @@ "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821" } }, - "author_association": "OWNER" + "author_association": "OWNER", + "active_lock_reason": null }, "repository": { "id": 186853002, @@ -54107,7 +48849,29 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" }, "sender": { "login": "Codertocat", @@ -54131,10 +48895,18 @@ } }, { - "action": "dismissed", - "review": { - "id": 237895671, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx", + "action": "deleted", + "comment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", + "pull_request_review_id": 237895671, + "id": 284312630, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", + "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", + "path": "README.md", + "position": 1, + "original_position": 1, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "user": { "login": "Codertocat", "id": 21031067, @@ -54155,30 +48927,50 @@ "type": "User", "site_admin": false }, - "body": null, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "submitted_at": "2019-05-15T15:20:38Z", - "state": "dismissed", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671", + "body": "Maybe you should use more emojji on this line.", + "created_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "author_association": "OWNER", "_links": { + "self": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" + }, "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671" + "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" }, "pull_request": { "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" } - } + }, + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 265, + "original_line": 265, + "side": "RIGHT" }, "pull_request": { - "url": "https://api.github.com/repos/hellomouse/GNS/pulls/902", - "id": 370123640, - "node_id": "MDExOlB1bGxSZXF1ZXN0MzcwMTIzNjQw", - "html_url": "https://github.com/hellomouse/GNS/pull/902", - "diff_url": "https://github.com/hellomouse/GNS/pull/902.diff", - "patch_url": "https://github.com/hellomouse/GNS/pull/902.patch", - "issue_url": "https://api.github.com/repos/hellomouse/GNS/issues/902", + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2", + "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff", + "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", + "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", "number": 2, "state": "open", "locked": false, @@ -54203,7 +48995,7 @@ "type": "User", "site_admin": false }, - "body": "", + "body": "This is a pretty simple change that we need to pull into master.", "created_at": "2019-05-15T15:20:33Z", "updated_at": "2019-05-15T15:20:38Z", "closed_at": null, @@ -54267,7 +49059,6 @@ } ], "milestone": null, - "draft": false, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -54546,7 +49337,6 @@ } }, "author_association": "OWNER", - "auto_merge": null, "active_lock_reason": null }, "repository": { @@ -54647,6 +49437,10 @@ "visibility": "public", "web_commit_signoff_required": false }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -54666,31 +49460,22 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" } }, { - "action": "submitted", - "review": { - "id": 237895671, - "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx", + "action": "edited", + "changes": { "body": { "from": "" } }, + "comment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", + "pull_request_review_id": 237895671, + "id": 284312630, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", + "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", + "path": "README.md", + "position": 1, + "original_position": 1, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "user": { "login": "Codertocat", "id": 21031067, @@ -54711,21 +49496,41 @@ "type": "User", "site_admin": false }, - "body": null, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "submitted_at": "2019-05-15T15:20:38Z", - "state": "commented", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671", + "body": "Maybe you should use more emojji on this line.", + "created_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "author_association": "OWNER", "_links": { + "self": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" + }, "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671" + "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" }, "pull_request": { "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" } - } + }, + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 265, + "original_line": 265, + "side": "RIGHT" }, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -54823,7 +49628,6 @@ } ], "milestone": null, - "draft": false, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -55102,7 +49906,6 @@ } }, "author_association": "OWNER", - "auto_merge": null, "active_lock_reason": null }, "repository": { @@ -55203,6 +50006,10 @@ "visibility": "public", "web_commit_signoff_required": false }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -55222,14 +50029,41 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "pull_request_review", + "description": "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](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\n\n### Availability for `pull_request_review`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `pull_request_review`\n\nAction type: dismissed\n\nA review on a pull request was dismissed.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `dismissed`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`pull_request` object Required\n\nProperties of `pull_request`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`review` object Required\n\nThe review that was affected.\n\nProperties of `review`\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["dismissed", "submitted"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "pull_request": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "review": { + "type": "object", + "description": "The review that was affected." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "submitted", + "action": "dismissed", "review": { "id": 237895671, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx", @@ -55256,7 +50090,7 @@ "body": null, "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "submitted_at": "2019-05-15T15:20:38Z", - "state": "commented", + "state": "dismissed", "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671", "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "author_association": "OWNER", @@ -55270,13 +50104,13 @@ } }, "pull_request": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2", - "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff", - "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", - "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", + "url": "https://api.github.com/repos/hellomouse/GNS/pulls/902", + "id": 370123640, + "node_id": "MDExOlB1bGxSZXF1ZXN0MzcwMTIzNjQw", + "html_url": "https://github.com/hellomouse/GNS/pull/902", + "diff_url": "https://github.com/hellomouse/GNS/pull/902.diff", + "patch_url": "https://github.com/hellomouse/GNS/pull/902.patch", + "issue_url": "https://api.github.com/repos/hellomouse/GNS/issues/902", "number": 2, "state": "open", "locked": false, @@ -55301,7 +50135,7 @@ "type": "User", "site_admin": false }, - "body": "This is a pretty simple change that we need to pull into master.", + "body": "", "created_at": "2019-05-15T15:20:33Z", "updated_at": "2019-05-15T15:20:38Z", "closed_at": null, @@ -55745,20 +50579,6 @@ "visibility": "public", "web_commit_signoff_required": false }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -55782,62 +50602,27 @@ "installation": { "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" } - } - ] - }, - { - "name": "pull_request_review_comment", - "description": "Activity related to pull request review comments in the pull request's unified diff. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[pull request review comments](https://docs.github.com/en/rest/reference/pulls#comments)\" REST API.", - "actions": ["created", "deleted", "edited"], - "properties": { - "changes": { - "type": "object", - "description": "The changes to the comment if the action was `edited`." - }, - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." - }, - "pull_request": { - "type": "object", - "description": "The [pull request](https://docs.github.com/en/rest/reference/pulls) the comment belongs to." - }, - "comment": { - "type": "object", - "description": "The [comment](https://docs.github.com/en/rest/reference/pulls#comments) itself." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ { - "action": "created", - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "action": "submitted", + "review": { + "id": 237895671, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx", "user": { "login": "Codertocat", "id": 21031067, @@ -55858,18 +50643,16 @@ "type": "User", "site_admin": false }, - "body": "Maybe you should use more emoji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", + "body": null, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "submitted_at": "2019-05-15T15:20:38Z", + "state": "commented", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671", "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "author_association": "OWNER", "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" + "href": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671" }, "pull_request": { "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" @@ -55915,21 +50698,8 @@ "merged_at": null, "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", "assignee": null, - "assignees": [], - "requested_reviewers": [], - "requested_teams": [], - "labels": [], - "milestone": null, - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", - "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", - "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "head": { - "label": "Codertocat:changes", - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { + "assignees": [ + { "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -55948,110 +50718,53 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "allow_squash_merge": true, - "allow_merge_commit": true, - "allow_rebase_merge": true, - "delete_branch_on_merge": false } - }, - "base": { - "label": "Codertocat:master", - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + ], + "requested_reviewers": [ + { + "login": "octocat", + "id": 5346, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "http://alambic.github.com/avatars/u/5346?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "http://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 1362934389, + "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", + "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", + "name": "bug", + "color": "d73a4a", + "default": true, + "description": "Something isn't working" + } + ], + "milestone": null, + "draft": false, + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", + "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", + "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "head": { + "label": "Codertocat:changes", + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", "user": { "login": "Codertocat", "id": 21031067, @@ -56165,10 +50878,133 @@ "open_issues": 2, "watchers": 0, "default_branch": "master", - "allow_squash_merge": true, - "allow_merge_commit": true, - "allow_rebase_merge": true, - "delete_branch_on_merge": false + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + } + }, + "base": { + "label": "Codertocat:master", + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "user": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:20:34Z", + "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 0, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false } }, "_links": { @@ -56197,7 +51033,9 @@ "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821" } }, - "author_association": "OWNER" + "author_association": "OWNER", + "auto_merge": null, + "active_lock_reason": null }, "repository": { "id": 186853002, @@ -56291,7 +51129,11 @@ "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -56312,21 +51154,17 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "created", - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "action": "submitted", + "review": { + "id": 237895671, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3MjM3ODk1Njcx", "user": { "login": "Codertocat", "id": 21031067, @@ -56347,41 +51185,21 @@ "type": "User", "site_admin": false }, - "body": "Maybe you should use more emojji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", + "body": null, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "submitted_at": "2019-05-15T15:20:38Z", + "state": "commented", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671", "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "author_association": "OWNER", "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" + "href": "https://github.com/Codertocat/Hello-World/pull/2#pullrequestreview-237895671" }, "pull_request": { "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" } - }, - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 265, - "original_line": 265, - "side": "RIGHT" + } }, "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", @@ -56479,6 +51297,7 @@ } ], "milestone": null, + "draft": false, "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", @@ -56757,6 +51576,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "active_lock_reason": null }, "repository": { @@ -56857,9 +51677,19 @@ "visibility": "public", "web_commit_signoff_required": false }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" }, "sender": { "login": "Codertocat", @@ -56880,77 +51710,42 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "pull_request_review_thread", + "description": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.\n\n### Availability for `pull_request_review_thread`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `pull_request_review_thread`\n\nAction type: resolved\n\nA comment thread on a pull request was marked as resolved.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `resolved`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`pull_request` object Required\n\nProperties of `pull_request`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.\n\n`thread` object Required\n\nProperties of `thread`", + "actions": ["resolved", "unresolved"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, + "pull_request": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "thread": { "type": "object", "description": "" } + }, + "examples": [ { - "action": "created", - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Maybe you should use more emojji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", - "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "author_association": "OWNER", - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" - }, - "pull_request": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - } - }, - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 265, - "original_line": 265, - "side": "RIGHT" - }, + "action": "resolved", "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "id": 279147437, @@ -57325,7 +52120,81 @@ } }, "author_association": "OWNER", - "active_lock_reason": null + "active_lock_reason": null, + "draft": false, + "auto_merge": null + }, + "thread": { + "node_id": "PRRT_kwDOFd42Pc4rQOUv", + "comments": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", + "pull_request_review_id": 237895671, + "id": 284312630, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", + "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", + "path": "README.md", + "position": 1, + "original_position": 1, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "user": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Maybe you should use more emojji on this line.", + "created_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", + "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", + "_links": { + "self": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" + }, + "html": { + "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" + }, + "pull_request": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" + } + }, + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 265, + "original_line": 265, + "side": "RIGHT" + } + ] }, "repository": { "id": 186853002, @@ -57429,20 +52298,6 @@ "id": 1, "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, "sender": { "login": "Codertocat", "id": 21031067, @@ -57465,74 +52320,7 @@ } }, { - "action": "deleted", - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Maybe you should use more emojji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", - "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "author_association": "OWNER", - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" - }, - "pull_request": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - } - }, - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 265, - "original_line": 265, - "side": "RIGHT" - }, + "action": "unresolved", "pull_request": { "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", "id": 279147437, @@ -57907,7 +52695,81 @@ } }, "author_association": "OWNER", - "active_lock_reason": null + "active_lock_reason": null, + "draft": false, + "auto_merge": null + }, + "thread": { + "node_id": "PRRT_kwDOFd42Pc4rQOUv", + "comments": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", + "pull_request_review_id": 237895671, + "id": 284312630, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", + "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", + "path": "README.md", + "position": 1, + "original_position": 1, + "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "user": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Maybe you should use more emojji on this line.", + "created_at": "2019-05-15T15:20:37Z", + "updated_at": "2019-05-15T15:20:38Z", + "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", + "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "author_association": "OWNER", + "_links": { + "self": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" + }, + "html": { + "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" + }, + "pull_request": { + "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" + } + }, + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 265, + "original_line": 265, + "side": "RIGHT" + } + ] }, "repository": { "id": 186853002, @@ -58031,22 +52893,88 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "push", + "description": "This event occurs when a commit or tag is pushed, or when a repository is cloned.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.\n\n### Availability for `push`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `push`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`after` string Required\n\nThe SHA of the most recent commit on `ref` after the push.\n\n`base_ref` string or null Required\n\n`before` string Required\n\nThe SHA of the most recent commit on `ref` before the push.\n\n`commits` array of objects Required\n\nAn 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 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.\n\nProperties of `commits`\n\n`compare` string Required\n\nURL 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.\n\n`created` boolean Required\n\nWhether this push created the `ref`.\n\n`deleted` boolean Required\n\nWhether this push deleted the `ref`.\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`forced` boolean Required\n\nWhether this push was a force push of the `ref`.\n\n`head_commit` object or null Required\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`pusher` object Required\n\nMetaproperties for Git author/committer information.\n\nProperties of `pusher`\n\n`ref` string Required\n\nThe full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.\n\n`repository` object Required\n\nA git repository\n\n`sender` object\n\nA GitHub user.", + "actions": [], + "properties": { + "after": { + "type": "string", + "description": "The SHA of the most recent commit on `ref` after the push." + }, + "base_ref": { "type": "string or null", "description": "" }, + "before": { + "type": "string", + "description": "The SHA of the most recent commit on `ref` before the push." + }, + "commits": { + "type": "array of objects", + "description": "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 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries." + }, + "compare": { + "type": "string", + "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." + }, + "created": { + "type": "boolean", + "description": "Whether this push created the `ref`." + }, + "deleted": { + "type": "boolean", + "description": "Whether this push deleted the `ref`." + }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "forced": { + "type": "boolean", + "description": "Whether this push was a force push of the `ref`." + }, + "head_commit": { "type": "object or null", "description": "" }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "pusher": { + "type": "object", + "description": "Metaproperties for Git author/committer information." + }, + "ref": { + "type": "string", + "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`." + }, + "repository": { "type": "object", "description": "A git repository" }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "edited", - "changes": { "body": { "from": "" } }, - "comment": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { + "ref": "refs/tags/simple-tag", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "0000000000000000000000000000000000000000", + "created": false, + "deleted": true, + "forced": false, + "base_ref": null, + "compare": "https://github.com/Codertocat/Hello-World/compare/d70c5c6fa638^...000000000000", + "commits": [], + "head_commit": null, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com", "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -58066,2693 +52994,140 @@ "type": "User", "site_admin": false }, - "body": "Maybe you should use more emojji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", - "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "author_association": "OWNER", - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" - }, - "pull_request": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - } - }, - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 265, - "original_line": 265, - "side": "RIGHT" + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://github.com/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": 1557933565, + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": 1557933657, + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "stargazers": 0, + "master_branch": "master", + "organization": "Octocoders", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, - "pull_request": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2", - "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff", - "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", - "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", - "number": 2, - "state": "open", - "locked": false, - "title": "Update the README with new information.", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "This is a pretty simple change that we need to pull into master.", - "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:38Z", - "closed_at": null, - "merged_at": null, - "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", - "assignee": null, - "assignees": [ - { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_reviewers": [ - { - "login": "octocat", - "id": 5346, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "http://alambic.github.com/avatars/u/5346?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "http://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [], - "labels": [ - { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true, - "description": "Something isn't working" - } - ], - "milestone": null, - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", - "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", - "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "head": { - "label": "Codertocat:changes", - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - } - }, - "base": { - "label": "Codertocat:master", - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2" - }, - "issue": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2" - }, - "comments": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821" - } - }, - "author_association": "OWNER", - "active_lock_reason": null - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "pull_request_review_thread", - "description": "Activity related to a comment thread on a pull request being marked as resolved or unresolved. The type of activity is specified in the `action` property of the payload object.", - "actions": ["resolved", "unresolved"], - "properties": { - "pull_request": { - "type": "object", - "description": "The [pull request](https://docs.github.com/en/rest/reference/pulls) the thread pertains to." - }, - "thread": { - "type": "object", - "description": "The thread that was affected." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "resolved", - "pull_request": { - "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118", - "id": 873298238, - "node_id": "PR_kwDOEL39TM40DXk-", - "html_url": "https://github.com/octo-org/octo-repo/pull/118", - "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff", - "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch", - "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118", - "number": 118, - "state": "open", - "locked": false, - "title": "Create issue-comment", - "user": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "body": "Issue comment test", - "created_at": "2022-03-07T16:14:34Z", - "updated_at": "2022-03-21T09:21:38Z", - "closed_at": null, - "merged_at": null, - "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1", - "assignee": null, - "assignees": [], - "requested_reviewers": [], - "requested_teams": [], - "labels": [], - "milestone": null, - "draft": false, - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits", - "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments", - "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf", - "head": { - "label": "octo-org:issue-comment", - "ref": "issue-comment", - "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf", - "user": { - "login": "octo-org", - "id": 67584941, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", - "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "repo": { - "id": 280886604, - "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 67584941, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", - "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "Change description", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2020-07-19T14:48:35Z", - "updated_at": "2022-03-11T11:56:22Z", - "pushed_at": "2022-04-01T09:37:36Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "git@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 646, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 60, - "license": null, - "allow_forking": false, - "is_template": false, - "topics": ["hey", "topic"], - "visibility": "private", - "forks": 0, - "open_issues": 60, - "watchers": 1, - "default_branch": "master" - } - }, - "base": { - "label": "octo-org:master", - "ref": "master", - "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca", - "user": { - "login": "octo-org", - "id": 67584941, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", - "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "repo": { - "id": 280886604, - "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 67584941, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", - "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "Change description", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2020-07-19T14:48:35Z", - "updated_at": "2022-03-11T11:56:22Z", - "pushed_at": "2022-04-01T09:37:36Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "git@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 646, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 60, - "license": null, - "allow_forking": false, - "is_template": false, - "topics": ["hey", "topic"], - "visibility": "private", - "forks": 0, - "open_issues": 60, - "watchers": 1, - "default_branch": "master" - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118" - }, - "html": { - "href": "https://github.com/octo-org/octo-repo/pull/118" - }, - "issue": { - "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118" - }, - "comments": { - "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf" - } - }, - "author_association": "CONTRIBUTOR", - "auto_merge": null, - "active_lock_reason": null - }, - "thread": { - "node_id": "PRRT_kwDOEL39TM4w7XDQ", - "comments": [ - { - "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280", - "pull_request_review_id": 901921390, - "id": 820867280, - "node_id": "PRRC_kwDOEL39TM4w7XDQ", - "diff_hunk": "@@ -0,0 +1 @@\n+issue comment", - "path": "issue-comment", - "position": 1, - "original_position": 1, - "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf", - "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf", - "user": { - "login": "jide2020", - "id": 64502150, - "node_id": "MDQ6VXNlcjY0NTAyMTUw", - "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/jide2020", - "html_url": "https://github.com/jide2020", - "followers_url": "https://api.github.com/users/jide2020/followers", - "following_url": "https://api.github.com/users/jide2020/following{/other_user}", - "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}", - "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions", - "organizations_url": "https://api.github.com/users/jide2020/orgs", - "repos_url": "https://api.github.com/users/jide2020/repos", - "events_url": "https://api.github.com/users/jide2020/events{/privacy}", - "received_events_url": "https://api.github.com/users/jide2020/received_events", - "type": "User", - "site_admin": false - }, - "body": "sup", - "created_at": "2022-03-07T16:16:48Z", - "updated_at": "2022-03-07T16:16:58Z", - "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280", - "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118", - "author_association": "COLLABORATOR", - "_links": { - "self": { - "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280" - }, - "html": { - "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280" - }, - "pull_request": { - "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118" - } - }, - "reactions": { - "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 1, - "original_line": 1, - "side": "RIGHT" - } - ] - }, - "repository": { - "id": 280886604, - "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 67584941, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", - "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "Change description", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2020-07-19T14:48:35Z", - "updated_at": "2022-03-11T11:56:22Z", - "pushed_at": "2022-04-01T09:37:36Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "git@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 646, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 60, - "license": null, - "allow_forking": false, - "is_template": false, - "topics": ["hey", "topic"], - "visibility": "private", - "forks": 0, - "open_issues": 60, - "watchers": 1, - "default_branch": "master" - }, - "organization": { - "login": "octo-org", - "id": 67584941, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", - "description": "" - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - } - }, - { - "action": "resolved", - "pull_request": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2", - "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff", - "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", - "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", - "number": 2, - "state": "open", - "locked": false, - "title": "Update the README with new information.", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "This is a pretty simple change that we need to pull into master.", - "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:38Z", - "closed_at": null, - "merged_at": null, - "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", - "assignee": null, - "assignees": [ - { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_reviewers": [ - { - "login": "octocat", - "id": 5346, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "http://alambic.github.com/avatars/u/5346?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "http://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [], - "labels": [ - { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true, - "description": "Something isn't working" - } - ], - "milestone": null, - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", - "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", - "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "head": { - "label": "Codertocat:changes", - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - } - }, - "base": { - "label": "Codertocat:master", - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2" - }, - "issue": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2" - }, - "comments": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821" - } - }, - "author_association": "OWNER", - "active_lock_reason": null, - "draft": false, - "auto_merge": null - }, - "thread": { - "node_id": "PRRT_kwDOFd42Pc4rQOUv", - "comments": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Maybe you should use more emojji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", - "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "author_association": "OWNER", - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" - }, - "pull_request": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - } - }, - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 265, - "original_line": 265, - "side": "RIGHT" - } - ] - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "unresolved", - "pull_request": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "id": 279147437, - "node_id": "MDExOlB1bGxSZXF1ZXN0Mjc5MTQ3NDM3", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2", - "diff_url": "https://github.com/Codertocat/Hello-World/pull/2.diff", - "patch_url": "https://github.com/Codertocat/Hello-World/pull/2.patch", - "issue_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2", - "number": 2, - "state": "open", - "locked": false, - "title": "Update the README with new information.", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "This is a pretty simple change that we need to pull into master.", - "created_at": "2019-05-15T15:20:33Z", - "updated_at": "2019-05-15T15:20:38Z", - "closed_at": null, - "merged_at": null, - "merge_commit_sha": "c4295bd74fb0f4fda03689c3df3f2803b658fd85", - "assignee": null, - "assignees": [ - { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_reviewers": [ - { - "login": "octocat", - "id": 5346, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "http://alambic.github.com/avatars/u/5346?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "http://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [], - "labels": [ - { - "id": 1362934389, - "node_id": "MDU6TGFiZWwxMzYyOTM0Mzg5", - "url": "https://api.github.com/repos/Codertocat/Hello-World/labels/bug", - "name": "bug", - "color": "d73a4a", - "default": true, - "description": "Something isn't working" - } - ], - "milestone": null, - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits", - "review_comments_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments", - "review_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "head": { - "label": "Codertocat:changes", - "ref": "changes", - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - } - }, - "base": { - "label": "Codertocat:master", - "ref": "master", - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2" - }, - "issue": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2" - }, - "comments": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/issues/2/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/statuses/ec26c3e57ca3a959ca5aad62de7213c562f8c821" - } - }, - "author_association": "OWNER", - "active_lock_reason": null, - "draft": false, - "auto_merge": null - }, - "thread": { - "node_id": "PRRT_kwDOFd42Pc4rQOUv", - "comments": [ - { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630", - "pull_request_review_id": 237895671, - "id": 284312630, - "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI4NDMxMjYzMA==", - "diff_hunk": "@@ -1 +1 @@\n-# Hello-World", - "path": "README.md", - "position": 1, - "original_position": 1, - "commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "original_commit_id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "user": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Maybe you should use more emojji on this line.", - "created_at": "2019-05-15T15:20:37Z", - "updated_at": "2019-05-15T15:20:38Z", - "html_url": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630", - "pull_request_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", - "author_association": "OWNER", - "_links": { - "self": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630" - }, - "html": { - "href": "https://github.com/Codertocat/Hello-World/pull/2#discussion_r284312630" - }, - "pull_request": { - "href": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2" - } - }, - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/comments/284312630/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "start_line": null, - "original_start_line": null, - "start_side": null, - "line": 265, - "original_line": 265, - "side": "RIGHT" - } - ] - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:34Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "push", - "description": "One or more commits are pushed to a repository branch or tag.", - "actions": [], - "properties": { - "ref": { - "type": "string", - "description": "The full [`git ref`](https://docs.github.com/en/rest/reference/git#refs) that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`." - }, - "before": { - "type": "string", - "description": "The SHA of the most recent commit on `ref` before the push." - }, - "after": { - "type": "string", - "description": "The SHA of the most recent commit on `ref` after the push." - }, - "created": { - "type": "boolean", - "description": "Whether this push created the `ref`." - }, - "deleted": { - "type": "boolean", - "description": "Whether this push deleted the `ref`." - }, - "forced": { - "type": "boolean", - "description": "Whether this push was a force push of the `ref`." - }, - "head_commit": { - "type": "object", - "description": "For pushes where `after` is or points to a commit object, an expanded representation of that commit. For pushes where `after` refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag." - }, - "compare": { - "type": "string", - "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." - }, - "commits": { - "type": "array", - "description": "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.)" - }, - "commits[][id]": { - "type": "string", - "description": "The SHA of the commit." - }, - "commits[][timestamp]": { - "type": "string", - "description": "The ISO 8601 timestamp of the commit." - }, - "commits[][message]": { - "type": "string", - "description": "The commit message." - }, - "commits[][author]": { - "type": "object", - "description": "The git author of the commit." - }, - "commits[][author][name]": { - "type": "string", - "description": "The git author's name." - }, - "commits[][author][email]": { - "type": "string", - "description": "The git author's email address." - }, - "commits[][url]": { - "type": "url", - "description": "URL that points to the commit API resource." - }, - "commits[][distinct]": { - "type": "boolean", - "description": "Whether this commit is distinct from any that have been pushed before." - }, - "commits[][added]": { - "type": "array", - "description": "An array of files added in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were added." - }, - "commits[][modified]": { - "type": "array", - "description": "An array of files modified by the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were modified." - }, - "commits[][removed]": { - "type": "array", - "description": "An array of files removed in the commit. For extremely large commits where GitHub is unable to calculate this list in a timely manner, this may be empty even if files were removed." - }, - "pusher": { - "type": "object", - "description": "The user who pushed the commits." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "ref": "refs/tags/simple-tag", - "before": "0000000000000000000000000000000000000000", - "after": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "created": true, - "deleted": false, - "forced": false, - "base_ref": null, - "compare": "https://github.com/Codertocat/Hello-World/compare/simple-tag", - "commits": [], - "head_commit": { - "id": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "tree_id": "4b825dc642cb6eb9a060e54bf8d69288fbee4904", - "distinct": true, - "message": "Adding a .gitignore file", - "timestamp": "2019-05-15T15:20:41Z", - "url": "https://github.com/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "author": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", - "username": "Codertocat" - }, - "committer": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", - "username": "Codertocat" - }, - "added": [".gitignore"], - "removed": [], - "modified": [] - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://github.com/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": 1557933565, - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": 1557933657, - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "stargazers": 0, - "master_branch": "master" - }, - "pusher": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "ref": "refs/tags/simple-tag", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "0000000000000000000000000000000000000000", - "created": false, - "deleted": true, - "forced": false, - "base_ref": null, - "compare": "https://github.com/Codertocat/Hello-World/compare/d70c5c6fa638^...000000000000", - "commits": [], - "head_commit": null, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://github.com/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": 1557933565, - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": 1557933657, - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "stargazers": 0, - "master_branch": "master", - "organization": "Octocoders", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "pusher": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "ref": "refs/tags/simple-tag", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "0000000000000000000000000000000000000000", - "created": false, - "deleted": true, - "forced": false, - "base_ref": null, - "compare": "https://github.com/Codertocat/Hello-World/compare/6113728f27ae...000000000000", - "commits": [], - "head_commit": null, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "pusher": { + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "ref": "refs/tags/simple-tag", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "0000000000000000000000000000000000000000", + "created": false, + "deleted": true, + "forced": false, + "base_ref": null, + "compare": "https://github.com/Codertocat/Hello-World/compare/6113728f27ae...000000000000", + "commits": [], + "head_commit": null, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com", "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -61375,565 +53750,21 @@ "email": "21031067+Codertocat@users.noreply.github.com" }, "added": ["README.md"], - "removed": [], - "modified": [] - } - }, - { - "ref": "refs/tags/simple-tag", - "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "after": "0000000000000000000000000000000000000000", - "created": false, - "deleted": true, - "forced": false, - "base_ref": null, - "compare": "https://github.com/Codertocat/Hello-World/compare/6113728f27ae...000000000000", - "commits": [], - "head_commit": null, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://github.com/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": 1557933565, - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": 1557933657, - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "stargazers": 0, - "master_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "pusher": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - } - ] - }, - { - "name": "release", - "description": "Activity related to a release. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[releases](https://docs.github.com/en/rest/reference/releases)\" REST API.", - "actions": [ - "created", - "deleted", - "edited", - "prereleased", - "published", - "released", - "unpublished" - ], - "properties": { - "changes[body][from]": { - "type": "string", - "description": "The previous version of the body if the action was `edited`." - }, - "changes[name][from]": { - "type": "string", - "description": "The previous version of the name if the action was `edited`." - }, - "release": { - "type": "object", - "description": "The [release](https://docs.github.com/en/rest/reference/repos/#get-a-release) object." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "published", - "release": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", - "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", - "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", - "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", - "id": 17372790, - "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", - "tag_name": "0.0.1", - "target_commitish": "master", - "name": null, - "draft": false, - "author": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "prerelease": false, - "created_at": "2019-05-15T15:19:25Z", - "published_at": "2019-05-15T15:20:53Z", - "assets": [], - "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", - "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": null - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "created", - "release": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", - "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", - "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", - "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", - "id": 17372790, - "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", - "tag_name": "0.0.1", - "target_commitish": "master", - "name": "", - "draft": false, - "author": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "prerelease": false, - "created_at": "2019-05-15T15:19:25Z", - "published_at": "2019-05-15T15:20:53Z", - "assets": [], - "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", - "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false + "removed": [], + "modified": [] } }, { - "action": "created", - "release": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", - "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", - "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", - "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", - "id": 17372790, - "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", - "tag_name": "0.0.1", - "target_commitish": "master", - "name": "", - "draft": false, - "author": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "prerelease": false, - "created_at": "2019-05-15T15:19:25Z", - "published_at": "2019-05-15T15:20:53Z", - "assets": [], - "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", - "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "", - "discussion_url": "https://github.com/Codertocat/Hello-World/discussions/4" - }, + "ref": "refs/tags/simple-tag", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "0000000000000000000000000000000000000000", + "created": false, + "deleted": true, + "forced": false, + "base_ref": null, + "compare": "https://github.com/Codertocat/Hello-World/compare/6113728f27ae...000000000000", + "commits": [], + "head_commit": null, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -61941,6 +53772,8 @@ "full_name": "Codertocat/Hello-World", "private": false, "owner": { + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com", "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -61963,7 +53796,7 @@ "html_url": "https://github.com/Codertocat/Hello-World", "description": null, "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", + "url": "https://github.com/Codertocat/Hello-World", "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", @@ -62000,9 +53833,9 @@ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", + "created_at": 1557933565, "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", + "pushed_at": 1557933657, "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -62027,11 +53860,31 @@ "open_issues": 2, "watchers": 0, "default_branch": "master", + "stargazers": 0, + "master_branch": "master", "is_template": false, "topics": [], "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "pusher": { + "name": "Codertocat", + "email": "21031067+Codertocat@users.noreply.github.com" + }, "sender": { "login": "Codertocat", "id": 21031067, @@ -62052,21 +53905,47 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "registry_package", + "description": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.\n\n### Availability for `registry_package`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `registry_package`\n\nAction type: published\n\nA package was published to a registry.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `published`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`registry_package` object Required\n\nProperties of `registry_package`\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["published"], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "registry_package": { "type": "object", "description": "" }, + "repository": { + "type": "object", + "description": "A repository on GitHub." }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "created", - "release": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", - "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", - "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", - "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", - "id": 17372790, - "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", - "tag_name": "0.0.1", - "target_commitish": "master", - "name": "", - "draft": false, - "author": { + "action": "published", + "registry_package": { + "id": 10696, + "name": "hello-world-npm", + "namespace": "Codertocat/hello-world", + "description": null, + "ecosystem": "docker", + "package_type": "npm", + "html_url": "https://github.com/Codertocat/hello-world/packages/10696", + "created_at": "2019-05-09T23:28:29Z", + "updated_at": "2019-05-09T23:28:29Z", + "owner": { "login": "Codertocat", "id": 21031067, "node_id": "MDQ6VXNlcjIxMDMxMDY3", @@ -62086,20 +53965,221 @@ "type": "User", "site_admin": false }, - "prerelease": false, - "created_at": "2019-05-15T15:19:25Z", - "published_at": "2019-05-15T15:20:53Z", - "assets": [], - "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", - "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "" + "package_version": { + "id": 57755791, + "version": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "name": "sha256:3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "description": "Hello-World in a docker container", + "summary": "Hello-World in a docker container", + "body": { + "repository": { + "repository": { + "id": 185882436, + "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=", + "name": "hello-world-npm", + "full_name": "Codertocat/hello-world-npm", + "private": true, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/hello-world-npm", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/hello-world-npm", + "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks", + "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events", + "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges", + "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments", + "created_at": "2019-05-09T22:53:26Z", + "updated_at": "2019-05-09T23:24:42Z", + "pushed_at": "2019-05-09T23:27:00Z", + "git_url": "git://github.com/Codertocat/hello-world-npm.git", + "ssh_url": "git@github.com:Codertocat/hello-world-npm.git", + "clone_url": "https://github.com/Codertocat/hello-world-npm.git", + "svn_url": "https://github.com/Codertocat/hello-world-npm", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "JavaScript", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 0, + "license": null, + "forks": 0, + "open_issues": 0, + "watchers": 0, + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + } + }, + "info": { + "type": "blob", + "oid": "326b0e08c815245a11be4b399c51e419f334f569", + "mode": 33188, + "name": "README.md", + "path": "README.md", + "size": null, + "collection": true + }, + "attributes": {}, + "_formatted": true + }, + "manifest": "", + "html_url": "https://github.com/orgs/Codertocat/packages/container/hello-world/57755791", + "target_commitish": "master", + "target_oid": "3da1996a8115d7616457760d9920b815241d0a03b34cf5f04e9a0e9d8de37498", + "created_at": "0001-01-01T00:00:00Z", + "updated_at": "0001-01-01T00:00:00Z", + "metadata": [], + "container_metadata": { + "tag": { + "name": "", + "digest": "sha256:6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b" + }, + "labels": { + "description": "Hello-World in a docker container", + "source": "https://github.com/Codertocat/hello-world", + "revision": "", + "image_url": "https://github.com/Codertocat/hello-world", + "licenses": "", + "all_labels": { + "org.opencontainers.image.url": "https://github.com/Codertocat/hello-world", + "org.opencontainers.image.licenses": "", + "org.opencontainers.image.title": "docker-hello-world", + "org.opencontainers.image.revision": "6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", + "org.opencontainers.image.created": "2019-05-09T23:28:29Z", + "org.opencontainers.image.version": "nightly", + "org.opencontainers.image.description": "Hello-World in a docker container", + "org.opencontainers.image.source": "https://github.com/Codertocat/hello-world" + } + }, + "manifest": { + "digest": "sha256:6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", + "media_type": "application/vnd.docker.distribution.manifest.v2+json", + "uri": "repositories/Codertocat/hello-world/manifests/sha256:6c62fb45fe66bfb1ea9a66abc38f6a0cc974292b", + "size": 1782, + "config": { + "digest": "sha256:37e1478a8ffb0513113dbbb172bfafdf56ba24014a671921a2593d83da7a0608", + "media_type": "application/vnd.docker.container.image.v1+json", + "size": 7205 + }, + "layers": [ + { + "digest": "sha256:fd18d0201d0ce0c5e103902d894f5d601fc5dde76688aa7dae786840141d23e4", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 26576195 + }, + { + "digest": "sha256:0fa20a868a60ceb7bc8a95981a4bd56fac4c2d9de1f8745eae546146e48a8e0f", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 51166445 + }, + { + "digest": "sha256:4f4fb700ef54461cfa02571ae0db9a0dc1e0cdb5577484a6d75e68dc38e8acc1", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 32 + }, + { + "digest": "sha256:2ad7497455cdab76764a94c36fa2fc898c146b4d996bbd01beda28ca303e8a62", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 130 + }, + { + "digest": "sha256:f09600ea01bd4ba5ef2a7d3690c7d46147b924e680cc9034194263b86f3d6bd7", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 12202 + }, + { + "digest": "sha256:783c2f94749191f27129ee0bb80ff4db26f49af8a82aa67c85fc9444ce189d0c", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 727 + }, + { + "digest": "sha256:3d98f361b22ebdff75986009b3077e5590d90ea81c9df95d0cf9e311436add74", + "media_type": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 41670773 + } + ] + } + }, + "package_files": [], + "installation_command": "docker pull ghcr.io/Codertocat/hello-world:", + "package_url": "ghcr.io/Codertocat/hello-world:" + }, + "registry": { + "about_url": "https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages", + "name": "GitHub CONTAINER registry", + "type": "CONTAINER", + "url": "https://CONTAINER.pkg.github.com/Codertocat", + "vendor": "GitHub Inc" + } }, "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, + "id": 185882436, + "node_id": "MDEwOlJlcG9zaXRvcnkxODU4ODI0MzY=", + "name": "hello-world-npm", + "full_name": "Codertocat/hello-world-npm", + "private": true, "owner": { "login": "Codertocat", "id": 21031067, @@ -62120,71 +54200,71 @@ "type": "User", "site_admin": false }, - "html_url": "https://github.com/Codertocat/Hello-World", + "html_url": "https://github.com/Codertocat/hello-world-npm", "description": null, "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", + "url": "https://api.github.com/repos/Codertocat/hello-world-npm", + "forks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/forks", + "keys_url": "https://api.github.com/repos/Codertocat/hello-world-npm/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world-npm/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/hello-world-npm/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/hello-world-npm/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/hello-world-npm/events", + "assignees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/hello-world-npm/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/hello-world-npm/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/hello-world-npm/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/hello-world-npm/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world-npm/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/hello-world-npm/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/hello-world-npm/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/hello-world-npm/merges", + "archive_url": "https://api.github.com/repos/Codertocat/hello-world-npm/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/hello-world-npm/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/hello-world-npm/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/hello-world-npm/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/hello-world-npm/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/hello-world-npm/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/hello-world-npm/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/hello-world-npm/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/hello-world-npm/deployments", + "created_at": "2019-05-09T22:53:26Z", + "updated_at": "2019-05-09T23:24:42Z", + "pushed_at": "2019-05-09T23:27:00Z", + "git_url": "git://github.com/Codertocat/hello-world-npm.git", + "ssh_url": "git@github.com:Codertocat/hello-world-npm.git", + "clone_url": "https://github.com/Codertocat/hello-world-npm.git", + "svn_url": "https://github.com/Codertocat/hello-world-npm", "homepage": null, "size": 0, "stargazers_count": 0, "watchers_count": 0, - "language": "Ruby", + "language": "JavaScript", "has_issues": true, "has_projects": true, "has_downloads": true, "has_wiki": true, - "has_pages": true, - "forks_count": 1, + "has_pages": false, + "forks_count": 0, "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 2, + "open_issues_count": 0, "license": null, - "forks": 1, - "open_issues": 2, + "forks": 0, + "open_issues": 0, "watchers": 0, "default_branch": "master", "is_template": false, @@ -62192,33 +54272,80 @@ "visibility": "public", "web_commit_signoff_required": false }, + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "login": "github-actions[bot]", + "id": 41898282, + "node_id": "MDM6Qm90NDE4OTgyODI=", + "avatar_url": "https://avatars.githubusercontent.com/in/15368?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github-actions%5Bbot%5D", + "html_url": "https://github.com/apps/github-actions", + "followers_url": "https://api.github.com/users/github-actions%5Bbot%5D/followers", + "following_url": "https://api.github.com/users/github-actions%5Bbot%5D/following{/other_user}", + "gists_url": "https://api.github.com/users/github-actions%5Bbot%5D/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-actions%5Bbot%5D/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-actions%5Bbot%5D/subscriptions", + "organizations_url": "https://api.github.com/users/github-actions%5Bbot%5D/orgs", + "repos_url": "https://api.github.com/users/github-actions%5Bbot%5D/repos", + "events_url": "https://api.github.com/users/github-actions%5Bbot%5D/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-actions%5Bbot%5D/received_events", + "type": "Bot", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } + } + ] + }, + { + "name": "release", + "description": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n### Availability for `release`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `release`\n\nAction type: created\n\nA draft was saved, or a release or pre-release was published without previously being saved as a draft.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`release` object Required\n\nThe [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.\n\nProperties of `release`\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": [ + "created", + "deleted", + "edited", + "prereleased", + "published", + "released" + ], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "release": { + "type": "object", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { - "action": "deleted", + "action": "created", "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -62375,14 +54502,10 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "deleted", + "action": "created", "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -62421,18 +54544,167 @@ "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", "body": "", - "reactions": { - "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - } + "discussion_url": "https://github.com/Codertocat/Hello-World/discussions/4" + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": "2019-05-15T15:20:52Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "action": "created", + "release": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", + "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", + "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", + "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", + "id": 17372790, + "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", + "tag_name": "0.0.1", + "target_commitish": "master", + "name": "", + "draft": false, + "author": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "prerelease": false, + "created_at": "2019-05-15T15:19:25Z", + "published_at": "2019-05-15T15:20:53Z", + "assets": [], + "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", + "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", + "body": "" }, "repository": { "id": 186853002, @@ -62558,8 +54830,7 @@ } }, { - "action": "edited", - "changes": { "name": { "from": "FOO" }, "body": { "from": "" } }, + "action": "deleted", "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -62716,11 +54987,14 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "edited", - "changes": { "name": { "from": "FOO" }, "body": { "from": "" } }, + "action": "deleted", "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -62889,10 +55163,15 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "prereleased", + "action": "edited", + "changes": { "name": { "from": "FOO" }, "body": { "from": "" } }, "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -62924,7 +55203,7 @@ "type": "User", "site_admin": false }, - "prerelease": true, + "prerelease": false, "created_at": "2019-05-15T15:19:25Z", "published_at": "2019-05-15T15:20:53Z", "assets": [], @@ -63051,6 +55330,179 @@ "site_admin": false } }, + { + "action": "edited", + "changes": { "name": { "from": "FOO" }, "body": { "from": "" } }, + "release": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", + "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", + "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", + "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", + "id": 17372790, + "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", + "tag_name": "0.0.1", + "target_commitish": "master", + "name": "", + "draft": false, + "author": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "prerelease": false, + "created_at": "2019-05-15T15:19:25Z", + "published_at": "2019-05-15T15:20:53Z", + "assets": [], + "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", + "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", + "body": "", + "reactions": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": "2019-05-15T15:20:52Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + }, { "action": "prereleased", "release": { @@ -63090,8 +55542,7 @@ "assets": [], "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "", - "discussion_url": "https://github.com/Codertocat/Hello-World/discussions/4" + "body": "" }, "repository": { "id": 186853002, @@ -63213,7 +55664,7 @@ } }, { - "action": "published", + "action": "prereleased", "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -63245,13 +55696,14 @@ "type": "User", "site_admin": false }, - "prerelease": false, + "prerelease": true, "created_at": "2019-05-15T15:19:25Z", "published_at": "2019-05-15T15:20:53Z", "assets": [], "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "" + "body": "", + "discussion_url": "https://github.com/Codertocat/Hello-World/discussions/4" }, "repository": { "id": 186853002, @@ -63411,8 +55863,7 @@ "assets": [], "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "", - "discussion_url": "https://github.com/Codertocat/Hello-World/discussions/4" + "body": "" }, "repository": { "id": 186853002, @@ -63534,7 +55985,7 @@ } }, { - "action": "released", + "action": "published", "release": { "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", @@ -63572,7 +56023,8 @@ "assets": [], "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", - "body": "" + "body": "", + "discussion_url": "https://github.com/Codertocat/Hello-World/discussions/4" }, "repository": { "id": 186853002, @@ -63692,328 +56144,48 @@ "type": "User", "site_admin": false } - } - ] - }, - { - "name": "repository_dispatch", - "description": "This event occurs when a GitHub App sends a `POST` request to the \"[Create a repository dispatch event](https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event)\" endpoint.", - "actions": ["on-demand-test"], - "properties": {}, - "examples": [ - { - "action": "on-demand-test", - "branch": "master", - "client_payload": {}, - "repository": { - "id": 17273051, - "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "My first repo on GitHub!", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2014-02-28T02:42:51Z", - "updated_at": "2018-10-10T15:58:51Z", - "pushed_at": "2018-10-10T15:58:47Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "git@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "", - "size": 59, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "open_issues_count": 23, - "license": null, - "forks": 1, - "open_issues": 23, - "watchers": 0, - "default_branch": "master" - }, - "organization": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "description": "Working better together!" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 375706, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2" - } }, { - "action": "on-demand-test", - "branch": "master", - "client_payload": {}, - "repository": { - "id": 17273051, - "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "private": true, - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "action": "released", + "release": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790", + "assets_url": "https://api.github.com/repos/Codertocat/Hello-World/releases/17372790/assets", + "upload_url": "https://uploads.github.com/repos/Codertocat/Hello-World/releases/17372790/assets{?name,label}", + "html_url": "https://github.com/Codertocat/Hello-World/releases/tag/0.0.1", + "id": 17372790, + "node_id": "MDc6UmVsZWFzZTE3MzcyNzkw", + "tag_name": "0.0.1", + "target_commitish": "master", + "name": "", + "draft": false, + "author": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", "site_admin": false }, - "html_url": "https://github.com/octo-org/octo-repo", - "description": "My first repo on GitHub!", - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "created_at": "2014-02-28T02:42:51Z", - "updated_at": "2018-10-10T15:58:51Z", - "pushed_at": "2018-10-10T15:58:47Z", - "git_url": "git://github.com/octo-org/octo-repo.git", - "ssh_url": "git@github.com:octo-org/octo-repo.git", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "svn_url": "https://github.com/octo-org/octo-repo", - "homepage": "https://example.com", - "size": 59, - "stargazers_count": 0, - "watchers_count": 0, - "language": "JavaScript", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "open_issues_count": 23, - "license": null, - "forks": 1, - "open_issues": 23, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "organization": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "description": "Working better together!" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false + "prerelease": false, + "created_at": "2019-05-15T15:19:25Z", + "published_at": "2019-05-15T15:20:53Z", + "assets": [], + "tarball_url": "https://api.github.com/repos/Codertocat/Hello-World/tarball/0.0.1", + "zipball_url": "https://api.github.com/repos/Codertocat/Hello-World/zipball/0.0.1", + "body": "" }, - "installation": { - "id": 375706, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2" - } - } - ] - }, - { - "name": "repository", - "description": "Activity related to a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[repositories](https://docs.github.com/en/rest/reference/repos)\" REST API.", - "actions": [ - "archived", - "created", - "deleted", - "edited", - "privatized", - "publicized", - "renamed", - "transferred", - "unarchived" - ], - "properties": { - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "publicized", "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -64081,8 +56253,8 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": "2019-05-15T15:20:52Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -64106,7 +56278,11 @@ "forks": 1, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -64128,7 +56304,70 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "repository_advisory", + "description": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.\n\n### Availability for `repository_advisory`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `repository_advisory`\n\nAction type: published\n\nA repository security advisory was published.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `published`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`repository_advisory` object Required\n\nA repository security advisory.\n\nProperties of `repository_advisory`\n\n`sender` object\n\nA GitHub user.", + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "repository_advisory": { + "type": "object", + "description": "A repository security advisory." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "actions": ["published"], + "examples": [] + }, + { + "name": "repository", + "description": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\n\n### Availability for `repository`\n\n* Enterprises\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `repository`\n\nAction type: archived\n\nA repository was archived.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `archived`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": [ + "archived", + "created", + "edited", + "privatized", + "publicized", + "renamed", + "transferred" + ], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ { "action": "created", "repository": { @@ -65789,136 +58028,145 @@ ] }, { - "name": "repository_import", - "description": "Activity related to a repository being imported to GitHub. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[source imports](https://docs.github.com/en/rest/reference/migrations#source-imports)\" REST API. To receive this event for a personal repository, you must create an empty repository prior to the import. This event can be triggered using either the [GitHub Importer](https://docs.github.com/en/articles/importing-a-repository-with-github-importer) or the [Source imports API](https://docs.github.com/en/rest/reference/migrations#source-imports).", - "actions": [], + "name": "repository_dispatch", + "description": "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](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n### Availability for `repository_dispatch`\n\n* GitHub Apps\n\n### Webhook payload object for `repository_dispatch`\n\nThe `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `sample.collected`\n\n`branch` string Required\n\n`client_payload` object or null Required\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object Required\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["sample.collected", "on-demand-test"], "properties": { - "status": { - "type": "string", - "description": "The final state of the import. This can be one of `success`, `cancelled`, or `failure`." + "branch": { "type": "string", "description": "" }, + "client_payload": { "type": "object or null", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ { - "status": "success", + "action": "on-demand-test", + "branch": "master", + "client_payload": {}, "repository": { - "id": 135493233, - "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", + "id": 17273051, + "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", "site_admin": false }, - "private": false, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, + "html_url": "https://github.com/octo-org/octo-repo", + "description": "My first repo on GitHub!", "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2018-05-30T20:18:04Z", - "updated_at": "2018-05-30T20:18:49Z", - "pushed_at": "2018-05-30T20:18:48Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2014-02-28T02:42:51Z", + "updated_at": "2018-10-10T15:58:51Z", + "pushed_at": "2018-10-10T15:58:47Z", + "git_url": "git://github.com/octo-org/octo-repo.git", + "ssh_url": "git@github.com:octo-org/octo-repo.git", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "svn_url": "https://github.com/octo-org/octo-repo", + "homepage": "https://example.com", + "size": 59, "stargazers_count": 0, "watchers_count": 0, - "language": null, + "language": "JavaScript", "has_issues": true, "has_projects": true, "has_downloads": true, "has_wiki": true, - "has_pages": true, - "forks_count": 0, + "has_pages": false, + "forks_count": 1, "mirror_url": null, "archived": false, - "open_issues_count": 2, + "open_issues_count": 23, "license": null, - "forks": 0, - "open_issues": 2, + "forks": 1, + "open_issues": 23, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "description": "Working better together!" }, "sender": { "login": "Codertocat", @@ -65939,8 +58187,42 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false + }, + "installation": { + "id": 375706, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2" } + } + ] + }, + { + "name": "repository_import", + "description": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).\n\n### Availability for `repository_import`\n\n* Repositories\n* Organizations\n\n### Webhook payload object for `repository_import`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`status` string Required\n\nCan be one of: `success`, `cancelled`, `failure`", + "actions": [], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "status": { + "type": "string", + "description": "Can be one of: `success`, `cancelled`, `failure`" + } + }, + "examples": [ { "status": "success", "repository": { @@ -66078,156 +58360,59 @@ ] }, { - "name": "repository_vulnerability_alert", - "description": "Activity related to security vulnerability alerts in a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[About Dependabot alerts](https://docs.github.com/en/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)\".", - "actions": ["create", "dismiss", "resolve"], + "name": "repository_ruleset", + "description": "This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\" For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\n### Availability for `repository_ruleset`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `repository_ruleset`\n\nAction type: created\n\nA repository ruleset was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`repository_ruleset` object Required\n\nA set of rules to apply when specified conditions are met.\n\nProperties of `repository_ruleset`\n\n`sender` object Required\n\nA GitHub user.", "properties": { - "alert": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { "type": "object", - "description": "The security alert of the vulnerable dependency." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." }, "repository": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "A repository on GitHub." + }, + "repository_ruleset": { + "type": "object", + "description": "A set of rules to apply when specified conditions are met." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "actions": ["created"], + "examples": [] + }, + { + "name": "repository_vulnerability_alert", + "description": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.\n\n### Availability for `repository_vulnerability_alert`\n\n* Repositories\n* Organizations\n\n### Webhook payload object for `repository_vulnerability_alert`\n\nAction type: create\n\nA repository vulnerability alert was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `create`\n\n`alert` Required\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "actions": ["create", "dismiss"], + "properties": { + "alert": { "type": "", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "create", - "alert": { - "id": 91095730, - "affected_range": ">= 2.0.4, < 2.0.6", - "affected_package_name": "rack", - "fixed_in": "2.0.6", - "external_reference": "https://nvd.nist.gov/vuln/detail/CVE-2018-16470", - "external_identifier": "CVE-2018-16470", - "severity": "moderate", - "ghsa_id": "GHSA-hg78-4f6x-99wq", - "created_at": "2021-03-01T01:23:45Z" - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:19:27Z", - "pushed_at": "2019-05-15T15:20:32Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 0, - "default_branch": "master" - }, - "sender": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars1.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - } - }, { "action": "create", "alert": { @@ -66671,50 +58856,226 @@ } ] }, + { + "name": "secret_scanning_alert", + "description": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n### Availability for `secret_scanning_alert`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `secret_scanning_alert`\n\nAction type: created\n\nA secret scanning alert was created.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`alert` object Required\n\nProperties of `alert`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object\n\nA GitHub user.", + "actions": ["created", "reopened"], + "properties": { + "alert": { "type": "object", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "examples": [ + { + "action": "reopened", + "alert": { + "number": 191, + "secret_type": "adafruit_io_key", + "resolution": null, + "resolved_by": null, + "resolved_at": null + }, + "repository": { + "id": 257423561, + "node_id": "MDEwOlJlcG9zaXRvcnkyNTc0MjM1NjE=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": true, + "owner": { + "login": "Codertocat", + "id": 30846345, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", + "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2020-04-20T22:59:11Z", + "updated_at": "2020-11-24T01:37:33Z", + "pushed_at": "2020-11-24T01:37:31Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 1156, + "stargazers_count": 0, + "watchers_count": 0, + "language": "JavaScript", + "has_issues": false, + "has_projects": false, + "has_downloads": true, + "has_wiki": false, + "has_pages": true, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false + }, + "organization": { + "login": "Codertocat", + "id": 30846345, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjMwODQ2MzQ1", + "url": "https://api.github.com/orgs/Codertocat", + "repos_url": "https://api.github.com/orgs/Codertocat/repos", + "events_url": "https://api.github.com/orgs/Codertocat/events", + "hooks_url": "https://api.github.com/orgs/Codertocat/hooks", + "issues_url": "https://api.github.com/orgs/Codertocat/issues", + "members_url": "https://api.github.com/orgs/Codertocat/members{/member}", + "public_members_url": "https://api.github.com/orgs/Codertocat/public_members{/member}", + "avatar_url": "https://avatars0.githubusercontent.com/u/30846345?v=4", + "description": "Demos and testing of GitHub security products" + }, + "sender": { + "login": "Codertocat", + "id": 10136561, + "node_id": "MDQ6VXNlcjEwMTM2NTYx", + "avatar_url": "https://avatars1.githubusercontent.com/u/10136561?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": true + } + } + ] + }, + { + "name": "secret_scanning_alert_location", + "description": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n### Availability for `secret_scanning_alert_location`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `secret_scanning_alert_location`\n\nA new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string\n\nValue: `created`\n\n`alert` object Required\n\nProperties of `alert`\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`location` object Required\n\nProperties of `location`\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", + "properties": { + "alert": { "type": "object", "description": "" }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "location": { "type": "object", "description": "" }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "actions": ["created"], + "examples": [] + }, { "name": "security_advisory", - "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About Dependabot alerts](https://docs.github.com/en/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"", - "actions": ["performed", "published", "updated", "withdrawn"], + "description": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"\n\n### Availability for `security_advisory`\n\n* GitHub Apps\n\n### Webhook payload object for `security_advisory`\n\nAction type: published\n\nA security advisory was published to the GitHub community.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `published`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`security_advisory` object Required\n\nThe details of the security advisory, including summary, description, and severity.\n\nProperties of `security_advisory`\n\n`sender` object\n\nA GitHub user.", + "actions": ["published", "updated", "withdrawn"], "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, "security_advisory": { "type": "object", "description": "The details of the security advisory, including summary, description, and severity." - } + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "published", - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "summary": "Moderate severity vulnerability that affects django", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "severity": "moderate", - "identifiers": [ - { "value": "GHSA-rf4j-j272-fj86", "type": "GHSA" }, - { "value": "CVE-2018-6188", "type": "CVE" } - ], - "references": [ - { "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2018-10-03T21:13:54Z", - "withdrawn_at": null, - "vulnerabilities": [ - { - "package": { "ecosystem": "pip", "name": "django" }, - "severity": "moderate", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { "identifier": "2.0.2" } - }, - { - "package": { "ecosystem": "pip", "name": "django" }, - "severity": "moderate", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { "identifier": "1.11.10" } - } - ] - } - }, { "action": "published", "security_advisory": { @@ -66823,205 +59184,54 @@ } ] }, + { + "name": "security_and_analysis", + "description": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\n### Availability for `security_and_analysis`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `security_and_analysis`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`changes` object Required\n\nProperties of `changes`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nFull Repository\n\n`sender` object\n\nA GitHub user.", + "properties": { + "changes": { "type": "object", "description": "" }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { "type": "object", "description": "Full Repository" }, + "sender": { "type": "object", "description": "A GitHub user." } + }, + "actions": [], + "examples": [] + }, { "name": "sponsorship", - "description": "Activity related to a sponsorship listing. The type of activity is specified in the `action` property of the payload object. For more information, see \"[About GitHub Sponsors](https://docs.github.com/en/sponsors/getting-started-with-github-sponsors/about-github-sponsors)\".\n\nYou can only create a sponsorship webhook on GitHub. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/en/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)\".", - "actions": [ - "cancelled", - "created", - "edited", - "pending_cancellation", - "pending_tier_change", - "tier_changed" - ], + "description": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"\n\n### Availability for `sponsorship`\n\n* Sponsored accounts\n\n### Webhook payload object for `sponsorship`\n\nAction type: cancelled\n\nA sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `cancelled`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`sponsorship` object Required\n\nProperties of `sponsorship`", + "actions": ["cancelled", "created", "pending_tier_change"], "properties": { - "effective_date": { - "type": "string", - "description": "The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect." + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, - "changes[tier][from]": { + "installation": { "type": "object", - "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](https://docs.github.com/en/webhooks/event-payloads#webhook-payload-example-when-someone-downgrades-a-sponsorship)." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "changes[privacy_level][from]": { - "type": "string", - "description": "The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy." + "organization": { + "type": "object", + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "sponsorship": { "type": "object", "description": "" } }, "examples": [ - { - "action": "created", - "sponsorship": { - "node_id": "MDExOlNwb25zb3JzaGlwMQ==", - "created_at": "2019-12-20T19:24:46+00:00", - "sponsorable": { - "login": "octocat", - "id": 5, - "node_id": "MDQ6VXNlcjU=", - "avatar_url": "https://avatars2.githubusercontent.com/u/5?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "sponsor": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://avatars2.githubusercontent.com/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "privacy_level": "public", - "tier": { - "node_id": "MDEyOlNwb25zb3JzVGllcjE=", - "created_at": "2019-12-20T19:17:05Z", - "description": "foo", - "monthly_price_in_cents": 500, - "monthly_price_in_dollars": 5, - "name": "$5 a month", - "is_one_time": false, - "is_custom_amount": false - } - }, - "sender": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://avatars2.githubusercontent.com/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - } - }, - { - "action": "pending_tier_change", - "sponsorship": { - "node_id": "MDExOlNwb25zb3JzaGlwMQ==", - "created_at": "2019-12-20T19:24:46+00:00", - "sponsorable": { - "login": "octocat", - "id": 5, - "node_id": "MDQ6VXNlcjU=", - "avatar_url": "https://avatars2.githubusercontent.com/u/5?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "sponsor": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://avatars2.githubusercontent.com/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "privacy_level": "private", - "tier": { - "node_id": "MDEyOlNwb25zb3JzVGllcjE=", - "created_at": "2019-12-20T19:17:05Z", - "description": "foo", - "monthly_price_in_cents": 500, - "monthly_price_in_dollars": 5, - "name": "$5 a month", - "is_one_time": false, - "is_custom_amount": false - } - }, - "changes": { - "tier": { - "from": { - "node_id": "MDEyOlNwb25zb3JzVGllcjI=", - "created_at": "2019-12-20T19:26:26Z", - "description": "bar", - "monthly_price_in_cents": 1000, - "monthly_price_in_dollars": 10, - "name": "$10 a month" - } - } - }, - "effective_date": "2019-12-30T00:00:00+00:00", - "sender": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://avatars2.githubusercontent.com/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - } - }, { "action": "created", "sponsorship": { @@ -67197,24 +59407,29 @@ }, { "name": "star", - "description": "Activity related to a repository being starred. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[starring](https://docs.github.com/en/rest/reference/activity#starring)\" REST API.", + "description": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\n\n### Availability for `star`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `star`\n\nAction type: created\n\nSomeone starred a repository.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `created`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`starred_at` string or null Required\n\nThe 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.", "actions": ["created", "deleted"], "properties": { - "starred_at": { - "type": "string", - "description": "The time the star was created. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action." + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "starred_at": { + "type": "string or null", + "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." } }, "examples": [ @@ -67288,247 +59503,7 @@ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:40Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 1, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "created", - "starred_at": "2019-05-15T15:20:40Z", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:40Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 1, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, - { - "action": "deleted", - "starred_at": null, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", + "updated_at": "2019-05-15T15:20:40Z", "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", @@ -67536,8 +59511,8 @@ "svn_url": "https://github.com/Codertocat/Hello-World", "homepage": null, "size": 0, - "stargazers_count": 0, - "watchers_count": 0, + "stargazers_count": 1, + "watchers_count": 1, "language": "Ruby", "has_issues": true, "has_projects": true, @@ -67552,7 +59527,7 @@ "license": null, "forks": 0, "open_issues": 2, - "watchers": 0, + "watchers": 1, "default_branch": "master", "is_template": false, "topics": [], @@ -67579,162 +59554,10 @@ "type": "User", "site_admin": false } - } - ] - }, - { - "name": "status", - "description": "When the status of a Git commit changes. For more information, see the \"[statuses](https://docs.github.com/en/rest/reference/commits#commit-statuses)\" REST API.", - "actions": [], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the status." }, - "sha": { "type": "string", "description": "The Commit SHA." }, - "state": { - "type": "string", - "description": "The new state. Can be `pending`, `success`, `failure`, or `error`." - }, - "description": { - "type": "string", - "description": "The optional human-readable description added to the status." - }, - "target_url": { - "type": "string", - "description": "The optional link added to the status." - }, - "branches": { - "type": "array", - "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." - }, - "repository": { - "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ { - "id": 6805126730, - "sha": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "name": "Codertocat/Hello-World", - "target_url": null, - "context": "default", - "description": null, - "state": "success", - "commit": { - "sha": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "node_id": "MDY6Q29tbWl0MTg2ODUzMDAyOjYxMTM3MjhmMjdhZTgyYzdiMWExNzdjOGQwM2Y5ZTk2ZTBhZGYyNDY=", - "commit": { - "author": { - "name": "Codertocat", - "email": "21031067+Codertocat@users.noreply.github.com", - "date": "2019-05-15T15:19:25Z" - }, - "committer": { - "name": "GitHub", - "email": "noreply@github.com", - "date": "2019-05-15T15:19:25Z" - }, - "message": "Initial commit", - "tree": { - "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4", - "url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4" - }, - "url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits/6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "comment_count": 1, - "verification": { - "verified": true, - "reason": "valid", - "signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJc3C39CRBK7hj4Ov3rIwAAdHIIABvaC0PQWgtUDQ5cz8ISR/Gf\npQYSuDMeeRa90wXzafPYowzID+UNU2eaRD4ak1bhb7kYVsZnPhUt5jTLKzr4Zuq8\nvt9ucrUvLDQWUZe2jX4wipM8ykWIlDho+9OAoocbVAn0kPBZEqJK74fH0Uj8vUfw\nIX71oq7XYsd2iGi9iMrYczr3aTe4EyQoYj/R+aAuRlLwU5LVciuyl0AmxMQXJ+qn\nowTpROWvXb1HijQZgx2x1lAEBzvahOiayOsJ+ZZ1DZX1lpXaSoeAjth1t2ckHlWW\n907fehmtX2cfccfrTLJC55QdhWU305ZtUoNRTp7TrdUecXnQcWKFcMmE/Yx1vps=\n=LQlK\n-----END PGP SIGNATURE-----\n", - "payload": "tree 1b13fc88733f95cc8cb16170f6990ef30d78acf4\nauthor Codertocat <21031067+Codertocat@users.noreply.github.com> 1557933565 -0500\ncommitter GitHub 1557933565 -0500\n\nInitial commit" - } - }, - "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "html_url": "https://github.com/Codertocat/Hello-World/commit/6113728f27ae82c7b1a177c8d03f9e96e0adf246", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/commits/6113728f27ae82c7b1a177c8d03f9e96e0adf246/comments", - "author": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "committer": { - "login": "web-flow", - "id": 19864447, - "node_id": "MDQ6VXNlcjE5ODY0NDQ3", - "avatar_url": "https://avatars3.githubusercontent.com/u/19864447?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/web-flow", - "html_url": "https://github.com/web-flow", - "followers_url": "https://api.github.com/users/web-flow/followers", - "following_url": "https://api.github.com/users/web-flow/following{/other_user}", - "gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}", - "starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/web-flow/subscriptions", - "organizations_url": "https://api.github.com/users/web-flow/orgs", - "repos_url": "https://api.github.com/users/web-flow/repos", - "events_url": "https://api.github.com/users/web-flow/events{/privacy}", - "received_events_url": "https://api.github.com/users/web-flow/received_events", - "type": "User", - "site_admin": false - }, - "parents": [] - }, - "branches": [ - { - "name": "master", - "commit": { - "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", - "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/f95f852bd8fca8fcc58a9a2d6c842781e32a215e" - }, - "protected": false - }, - { - "name": "changes", - "commit": { - "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", - "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/ec26c3e57ca3a959ca5aad62de7213c562f8c821" - }, - "protected": false - }, - { - "name": "gh-pages", - "commit": { - "sha": "507fc9acd0d04ac4a9db87d12cb228c052cd813a", - "url": "https://api.github.com/repos/Codertocat/Hello-World/commits/507fc9acd0d04ac4a9db87d12cb228c052cd813a" - }, - "protected": false - } - ], - "created_at": "2019-05-15T15:20:55+00:00", - "updated_at": "2019-05-15T15:20:55+00:00", + "action": "deleted", + "starred_at": null, "repository": { "id": 186853002, "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", @@ -67803,7 +59626,7 @@ "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", "created_at": "2019-05-15T15:19:25Z", "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", + "pushed_at": "2019-05-15T15:20:33Z", "git_url": "git://github.com/Codertocat/Hello-World.git", "ssh_url": "git@github.com:Codertocat/Hello-World.git", "clone_url": "https://github.com/Codertocat/Hello-World.git", @@ -67818,16 +59641,20 @@ "has_downloads": true, "has_wiki": true, "has_pages": true, - "forks_count": 1, + "forks_count": 0, "mirror_url": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, - "forks": 1, + "forks": 0, "open_issues": 2, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -67849,7 +59676,60 @@ "type": "User", "site_admin": false } + } + ] + }, + { + "name": "status", + "description": "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](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.\n\n### Availability for `status`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `status`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`avatar_url` string or null\n\n`branches` array of objects Required\n\nAn 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.\n\nProperties of `branches`\n\n`commit` object Required\n\nProperties of `commit`\n\n`context` string Required\n\n`created_at` string Required\n\n`description` string or null Required\n\nThe optional human-readable description added to the status.\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`id` integer Required\n\nThe unique identifier of the status.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`name` string Required\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`sha` string Required\n\nThe Commit SHA.\n\n`state` string Required\n\nThe new state. Can be `pending`, `success`, `failure`, or `error`.\n\nCan be one of: `pending`, `success`, `failure`, `error`\n\n`target_url` string or null Required\n\nThe optional link added to the status.\n\n`updated_at` string Required", + "actions": [], + "properties": { + "avatar_url": { "type": "string or null", "description": "" }, + "branches": { + "type": "array of objects", + "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." }, + "commit": { "type": "object", "description": "" }, + "context": { "type": "string", "description": "" }, + "created_at": { "type": "string", "description": "" }, + "description": { + "type": "string or null", + "description": "The optional human-readable description added to the status." + }, + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the status." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." + }, + "name": { "type": "string", "description": "" }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "sha": { "type": "string", "description": "The Commit SHA." }, + "state": { + "type": "string", + "description": "The new state. Can be `pending`, `success`, `failure`, or `error`." + }, + "target_url": { + "type": "string or null", + "description": "The optional link added to the status." + }, + "updated_at": { "type": "string", "description": "" } + }, + "examples": [ { "id": 6805126730, "sha": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", @@ -68424,260 +60304,54 @@ "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:41Z", - "pushed_at": "2019-05-15T15:20:52Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - }, - "avatar_url": "https://avatars2.githubusercontent.com/oa/39145?v=4" - } - ] - }, - { - "name": "team", - "description": "Activity related to an organization's team. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[teams](https://docs.github.com/en/rest/reference/teams)\" REST API.", - "actions": [ - "added_to_repository", - "created", - "deleted", - "edited", - "removed_from_repository" - ], - "properties": { - "team": { "type": "object", "description": "The team itself." }, - "changes": { - "type": "object", - "description": "The changes to the team if the action was `edited`." - }, - "changes[description][from]": { - "type": "string", - "description": "The previous version of the description if the action was `edited`." - }, - "changes[name][from]": { - "type": "string", - "description": "The previous version of the name if the action was `edited`." - }, - "changes[privacy][from]": { - "type": "string", - "description": "The previous version of the team's privacy if the action was `edited`." - }, - "changes[repository][permissions][from][admin]": { - "type": "boolean", - "description": "The previous version of the team member's `admin` permission on a repository, if the action was `edited`." - }, - "changes[repository][permissions][from][pull]": { - "type": "boolean", - "description": "The previous version of the team member's `pull` permission on a repository, if the action was `edited`." - }, - "changes[repository][permissions][from][push]": { - "type": "boolean", - "description": "The previous version of the team member's `push` permission on a repository, if the action was `edited`." - }, - "repository": { - "type": "object", - "description": "The repository that was added or removed from to the team's purview if the action was `added_to_repository`, `removed_from_repository`, or `edited`. For `edited` actions, `repository` also contains the team's new permission levels for the repository." - }, - "organization": { - "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } - }, - "examples": [ - { - "action": "added_to_repository", - "team": { - "name": "github", - "id": 3253328, - "node_id": "MDQ6VGVhbTMyNTMzMjg=", - "slug": "github", - "description": "Open-source team", - "privacy": "secret", - "url": "https://api.github.com/teams/3253328", - "html_url": "https://github.com/orgs/Octocoders/teams/github", - "members_url": "https://api.github.com/teams/3253328/members{/member}", - "repositories_url": "https://api.github.com/teams/3253328/repos", - "permission": "pull" - }, - "repository": { - "id": 186853261, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", - "name": "Hello-World", - "full_name": "Octocoders/Hello-World", - "private": false, - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/Octocoders/Hello-World", - "description": null, - "fork": true, - "url": "https://api.github.com/repos/Octocoders/Hello-World", - "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", - "created_at": "2019-05-15T15:20:42Z", - "updated_at": "2019-05-15T15:20:45Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Octocoders/Hello-World.git", - "ssh_url": "git@github.com:Octocoders/Hello-World.git", - "clone_url": "https://github.com/Octocoders/Hello-World.git", - "svn_url": "https://github.com/Octocoders/Hello-World", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:20:41Z", + "pushed_at": "2019-05-15T15:20:52Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", "homepage": null, "size": 0, "stargazers_count": 0, "watchers_count": 0, "language": "Ruby", - "has_issues": false, + "has_issues": true, "has_projects": true, "has_downloads": true, "has_wiki": true, - "has_pages": false, - "forks_count": 0, + "has_pages": true, + "forks_count": 1, "mirror_url": null, "archived": false, "disabled": false, - "open_issues_count": 0, + "open_issues_count": 2, "license": null, - "forks": 0, - "open_issues": 0, + "forks": 1, + "open_issues": 2, "watchers": 0, "default_branch": "master", - "permissions": { "pull": true, "push": false, "admin": false } - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "sender": { "login": "Codertocat", @@ -68698,10 +60372,44 @@ "received_events_url": "https://api.github.com/users/Codertocat/received_events", "type": "User", "site_admin": false - } + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + }, + "avatar_url": "https://avatars2.githubusercontent.com/oa/39145?v=4" + } + ] + }, + { + "name": "team_add", + "description": "This event occurs when a team is added to a repository. For more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\n\n### Availability for `team_add`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `team_add`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`team` object Required\n\nGroups of organization members that gives permissions on specified repositories.\n\nProperties of `team`", + "actions": [], + "properties": { + "enterprise": { + "type": "object", + "description": "An enterprise on GitHub." + }, + "installation": { + "type": "object", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, + "organization": { + "type": "object", + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." }, + "team": { + "type": "object", + "description": "Groups of organization members that gives permissions on specified repositories." + } + }, + "examples": [ { - "action": "added_to_repository", "team": { "name": "github", "id": 3253328, @@ -68709,7 +60417,6 @@ "slug": "github", "description": "Open-source team", "privacy": "secret", - "notification_setting": "notifications_enabled", "url": "https://api.github.com/teams/3253328", "html_url": "https://github.com/orgs/Octocoders/teams/github", "members_url": "https://api.github.com/teams/3253328/members{/member}", @@ -68809,7 +60516,6 @@ "open_issues": 0, "watchers": 0, "default_branch": "master", - "permissions": { "pull": true, "push": false, "admin": false }, "is_template": false, "topics": [], "visibility": "public", @@ -68830,198 +60536,27 @@ "description": "" }, "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } - }, - { - "action": "created", - "team": { - "name": "github", - "id": 3253328, - "node_id": "MDQ6VGVhbTMyNTMzMjg=", - "slug": "github", - "description": null, - "privacy": "secret", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/3253328", - "html_url": "https://github.com/orgs/Octocoders/teams/github", - "members_url": "https://api.github.com/teams/3253328/members{/member}", - "repositories_url": "https://api.github.com/teams/3253328/repos", - "permission": "pull" - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } - }, - { - "action": "deleted", - "team": { - "name": "github", - "id": 3253328, - "node_id": "MDQ6VGVhbTMyNTMzMjg=", - "slug": "github", - "description": "Open-source team", - "privacy": "secret", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/3253328", - "html_url": "https://github.com/orgs/Octocoders/teams/github", - "members_url": "https://api.github.com/teams/3253328/members{/member}", - "repositories_url": "https://api.github.com/teams/3253328/repos", - "permission": "pull" - }, - "organization": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" - } - }, - { - "changes": {}, - "action": "edited", - "team": { - "name": "github", - "id": 3253328, - "node_id": "MDQ6VGVhbTMyNTMzMjg=", - "slug": "github", - "description": "Open-source team", - "privacy": "secret", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/3253328", - "html_url": "https://github.com/orgs/Octocoders/teams/github", - "members_url": "https://api.github.com/teams/3253328/members{/member}", - "repositories_url": "https://api.github.com/teams/3253328/repos", - "permission": "pull" - }, - "organization": { "login": "Octocoders", "id": 38302899, "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "url": "https://api.github.com/orgs/Octocoders", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "description": "" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", "site_admin": false - }, - "installation": { - "id": 1, - "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { - "action": "removed_from_repository", "team": { "name": "github", "id": 3253328, @@ -69029,7 +60564,6 @@ "slug": "github", "description": "Open-source team", "privacy": "secret", - "notification_setting": "notifications_enabled", "url": "https://api.github.com/teams/3253328", "html_url": "https://github.com/orgs/Octocoders/teams/github", "members_url": "https://api.github.com/teams/3253328/members{/member}", @@ -69110,7 +60644,7 @@ "clone_url": "https://github.com/Octocoders/Hello-World.git", "svn_url": "https://github.com/Octocoders/Hello-World", "homepage": null, - "size": 371886, + "size": 0, "stargazers_count": 0, "watchers_count": 0, "language": "Ruby", @@ -69129,13 +60663,6 @@ "open_issues": 0, "watchers": 0, "default_branch": "master", - "permissions": { - "pull": false, - "triage": false, - "push": false, - "maintain": false, - "admin": false - }, "is_template": false, "topics": [], "visibility": "public", @@ -69156,23 +60683,23 @@ "description": "" }, "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", "site_admin": false }, "installation": { @@ -69183,33 +60710,38 @@ ] }, { - "name": "team_add", - "description": "When a [repository is added to a team](https://docs.github.com/en/rest/reference/teams#add-or-update-team-repository-permissions).", - "actions": [], + "name": "team", + "description": "This event occurs when there is activity relating to teams in an organization. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.\n\n### Availability for `team`\n\n* Organizations\n* Enterprises\n* GitHub Apps\n\n### Webhook payload object for `team`\n\nAction type: added\\_to\\_repository\n\nA team was granted access to a repository.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `added_to_repository`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object Required\n\nA GitHub organization.\n\n`repository` object\n\nA git repository\n\n`sender` object\n\nA GitHub user.\n\n`team` object Required\n\nGroups of organization members that gives permissions on specified repositories.\n\nProperties of `team`", + "actions": [ + "added_to_repository", + "created", + "deleted", + "edited", + "removed_from_repository" + ], "properties": { - "team": { + "enterprise": { "type": "object", - "description": "The [team](https://docs.github.com/en/rest/reference/teams) that was modified. **Note:** Older events may not include this in the payload." + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, - "installation": { - "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." - }, - "sender": { + "repository": { "type": "object", "description": "A git repository" }, + "sender": { "type": "object", "description": "A GitHub user." }, + "team": { "type": "object", - "description": "The user that triggered the event." + "description": "Groups of organization members that gives permissions on specified repositories." } }, "examples": [ { + "action": "added_to_repository", "team": { "name": "github", "id": 3253328, @@ -69217,6 +60749,7 @@ "slug": "github", "description": "Open-source team", "privacy": "secret", + "notification_setting": "notifications_enabled", "url": "https://api.github.com/teams/3253328", "html_url": "https://github.com/orgs/Octocoders/teams/github", "members_url": "https://api.github.com/teams/3253328/members{/member}", @@ -69315,7 +60848,12 @@ "forks": 0, "open_issues": 0, "watchers": 0, - "default_branch": "master" + "default_branch": "master", + "permissions": { "pull": true, "push": false, "admin": false }, + "is_template": false, + "topics": [], + "visibility": "public", + "web_commit_signoff_required": false }, "organization": { "login": "Octocoders", @@ -69332,137 +60870,100 @@ "description": "" }, "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { + "action": "created", "team": { "name": "github", "id": 3253328, "node_id": "MDQ6VGVhbTMyNTMzMjg=", "slug": "github", - "description": "Open-source team", + "description": null, "privacy": "secret", + "notification_setting": "notifications_enabled", "url": "https://api.github.com/teams/3253328", "html_url": "https://github.com/orgs/Octocoders/teams/github", "members_url": "https://api.github.com/teams/3253328/members{/member}", "repositories_url": "https://api.github.com/teams/3253328/repos", "permission": "pull" }, - "repository": { - "id": 186853261, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", - "name": "Hello-World", - "full_name": "Octocoders/Hello-World", - "private": false, - "owner": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/Octocoders/Hello-World", - "description": null, - "fork": true, - "url": "https://api.github.com/repos/Octocoders/Hello-World", - "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", - "created_at": "2019-05-15T15:20:42Z", - "updated_at": "2019-05-15T15:20:45Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Octocoders/Hello-World.git", - "ssh_url": "git@github.com:Octocoders/Hello-World.git", - "clone_url": "https://github.com/Octocoders/Hello-World.git", - "svn_url": "https://github.com/Octocoders/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": false, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "master", - "is_template": false, - "topics": [], - "visibility": "public", - "web_commit_signoff_required": false + "organization": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + } + }, + { + "action": "deleted", + "team": { + "name": "github", + "id": 3253328, + "node_id": "MDQ6VGVhbTMyNTMzMjg=", + "slug": "github", + "description": "Open-source team", + "privacy": "secret", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/3253328", + "html_url": "https://github.com/orgs/Octocoders/teams/github", + "members_url": "https://api.github.com/teams/3253328/members{/member}", + "repositories_url": "https://api.github.com/teams/3253328/repos", + "permission": "pull" }, "organization": { "login": "Octocoders", @@ -69479,27 +60980,88 @@ "description": "" }, "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" + } + }, + { + "changes": {}, + "action": "edited", + "team": { + "name": "github", + "id": 3253328, + "node_id": "MDQ6VGVhbTMyNTMzMjg=", + "slug": "github", + "description": "Open-source team", + "privacy": "secret", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/3253328", + "html_url": "https://github.com/orgs/Octocoders/teams/github", + "members_url": "https://api.github.com/teams/3253328/members{/member}", + "repositories_url": "https://api.github.com/teams/3253328/repos", + "permission": "pull" + }, + "organization": { "login": "Octocoders", "id": 38302899, "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "url": "https://api.github.com/orgs/Octocoders", + "repos_url": "https://api.github.com/orgs/Octocoders/repos", + "events_url": "https://api.github.com/orgs/Octocoders/events", + "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", + "issues_url": "https://api.github.com/orgs/Octocoders/issues", + "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", + "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "description": "" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", "site_admin": false + }, + "installation": { + "id": 1, + "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ==" } }, { + "action": "removed_from_repository", "team": { "name": "github", "id": 3253328, @@ -69507,6 +61069,7 @@ "slug": "github", "description": "Open-source team", "privacy": "secret", + "notification_setting": "notifications_enabled", "url": "https://api.github.com/teams/3253328", "html_url": "https://github.com/orgs/Octocoders/teams/github", "members_url": "https://api.github.com/teams/3253328/members{/member}", @@ -69587,7 +61150,7 @@ "clone_url": "https://github.com/Octocoders/Hello-World.git", "svn_url": "https://github.com/Octocoders/Hello-World", "homepage": null, - "size": 0, + "size": 371886, "stargazers_count": 0, "watchers_count": 0, "language": "Ruby", @@ -69606,6 +61169,13 @@ "open_issues": 0, "watchers": 0, "default_branch": "master", + "permissions": { + "pull": false, + "triage": false, + "push": false, + "maintain": false, + "admin": false + }, "is_template": false, "topics": [], "visibility": "public", @@ -69626,23 +61196,23 @@ "description": "" }, "sender": { - "login": "Octocoders", - "id": 38302899, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", - "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", "gravatar_id": "", - "url": "https://api.github.com/users/Octocoders", - "html_url": "https://github.com/Octocoders", - "followers_url": "https://api.github.com/users/Octocoders/followers", - "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", - "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", - "organizations_url": "https://api.github.com/users/Octocoders/orgs", - "repos_url": "https://api.github.com/users/Octocoders/repos", - "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", - "received_events_url": "https://api.github.com/users/Octocoders/received_events", - "type": "Organization", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", "site_admin": false }, "installation": { @@ -69654,144 +61224,28 @@ }, { "name": "watch", - "description": "When someone stars a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[starring](https://docs.github.com/en/rest/reference/activity#starring)\" REST API.\n\nThe event’s actor is the [user](https://docs.github.com/en/rest/reference/users) who starred a repository, and the event’s repository is the [repository](https://docs.github.com/en/rest/reference/repos) that was starred.", + "description": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.\n\n### Availability for `watch`\n\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `watch`\n\nSomeone started watching the repository.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `started`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.", "actions": ["started"], "properties": { - "repository": { + "enterprise": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "An enterprise on GitHub." }, - "organization": { + "installation": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "installation": { + "organization": { "type": "object", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App." + "description": "A GitHub organization." }, - "sender": { + "repository": { "type": "object", - "description": "The user that triggered the event." - } + "description": "A repository on GitHub." + }, + "sender": { "type": "object", "description": "A GitHub user." } }, "examples": [ - { - "action": "started", - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "Hello-World", - "full_name": "Codertocat/Hello-World", - "private": false, - "owner": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/Codertocat/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:20:40Z", - "pushed_at": "2019-05-15T15:20:33Z", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "svn_url": "https://github.com/Codertocat/Hello-World", - "homepage": null, - "size": 0, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 0, - "open_issues": 2, - "watchers": 1, - "default_branch": "master" - }, - "sender": { - "login": "Codertocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/Codertocat", - "html_url": "https://github.com/Codertocat", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "type": "User", - "site_admin": false - } - }, { "action": "started", "repository": { @@ -70042,172 +61496,31 @@ }, { "name": "workflow_dispatch", - "description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"", + "description": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n### Availability for `workflow_dispatch`\n\n* GitHub Apps\n\n### Webhook payload object for `workflow_dispatch`\n\nWebhook request body parameters\n\nName, Type, Description\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`inputs` object or null Required\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`ref` string Required\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`workflow` string Required", "actions": [], "properties": { - "inputs": { + "enterprise": { "type": "object", - "description": "Inputs to the workflow. Each key represents the name of the input while its value represents the value of that input." + "description": "An enterprise on GitHub." }, - "organization": { + "inputs": { "type": "object or null", "description": "" }, + "installation": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." - }, - "ref": { - "type": "string", - "description": "The branch or tag from which the workflow was run." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, - "repository": { + "organization": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "A GitHub organization." }, - "sender": { + "ref": { "type": "string", "description": "" }, + "repository": { "type": "object", - "description": "The user that triggered the event." + "description": "A repository on GitHub." }, - "workflow": { - "type": "string", - "description": "Relative path to the workflow file which contains the workflow." - } + "sender": { "type": "object", "description": "A GitHub user." }, + "workflow": { "type": "string", "description": "" } }, "examples": [ - { - "inputs": {}, - "organization": { - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "description": null, - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "id": 79927191, - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "login": "octo-org", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "url": "https://api.github.com/orgs/octo-org" - }, - "ref": "refs/heads/main", - "repository": { - "allow_forking": true, - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "archived": false, - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "clone_url": "https://github.com/octo-org/octo-repo.git", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "created_at": "2021-08-16T21:34:28Z", - "default_branch": "main", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "description": null, - "disabled": false, - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "fork": false, - "forks": 1, - "forks_count": 1, - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "full_name": "octo-org/octo-repo", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "git_url": "git://github.com/octo-org/octo-repo.git", - "has_downloads": true, - "has_issues": true, - "has_pages": false, - "has_projects": true, - "has_wiki": true, - "homepage": null, - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "html_url": "https://github.com/octo-org/octo-repo", - "id": 6811672, - "is_template": false, - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "language": null, - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "license": null, - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "mirror_url": null, - "name": "octo-repo", - "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "open_issues": 97, - "open_issues_count": 97, - "owner": { - "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/octo-org", - "id": 79927191, - "login": "octo-org", - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "repos_url": "https://api.github.com/users/octo-org/repos", - "site_admin": false, - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "type": "Organization", - "url": "https://api.github.com/users/octo-org" - }, - "private": false, - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "pushed_at": "2022-01-07T21:57:21Z", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "size": 144, - "ssh_url": "git@github.com:octo-org/octo-repo.git", - "stargazers_count": 0, - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "svn_url": "https://github.com/octo-org/octo-repo", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "topics": [], - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "updated_at": "2022-01-07T21:57:24Z", - "url": "https://api.github.com/repos/octo-org/octo-repo", - "visibility": "public", - "watchers": 0, - "watchers_count": 0 - }, - "sender": { - "avatar_url": "https://avatars.githubusercontent.com/u/25328854?v=4", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/octocat", - "id": 25328754, - "login": "octocat", - "node_id": "MDQ6VXNlcjI1MzI4ODU0", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "repos_url": "https://api.github.com/users/octocat/repos", - "site_admin": true, - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "type": "User", - "url": "https://api.github.com/users/octocat" - }, - "workflow": ".github/workflows/hello-world-workflow.yml" - }, { "inputs": {}, "ref": "refs/heads/master", @@ -70348,212 +61661,33 @@ }, { "name": "workflow_job", - "description": "A GitHub Actions workflow job has been queued, is in progress, or has been completed on a repository. The type of activity is specified in the `action` property of the payload object.", + "description": "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](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.\n\n### Availability for `workflow_job`\n\n* Enterprises\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `workflow_job`\n\nAction type: completed\n\nA 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.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `completed`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`workflow_job` Required\n\n`deployment` object\n\nA request for a specific ref(branch,sha,tag) to be deployed\n\nProperties of `deployment`", "actions": ["completed", "in_progress", "queued", "waiting"], "properties": { - "workflow_job": { + "enterprise": { "type": "object", - "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object." - }, - "workflow_job[status]": { - "type": "string", - "description": "The current status of the job. Can be `queued`, `in_progress`, or `completed`." - }, - "workflow_job[labels]": { - "type": "array", - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML." - }, - "workflow_job[runner_id]": { - "type": "integer", - "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." - }, - "workflow_job[runner_name]": { - "type": "string", - "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." - }, - "workflow_job[runner_group_id]": { - "type": "integer", - "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." - }, - "workflow_job[runner_group_name]": { - "type": "string", - "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." + "description": "An enterprise on GitHub." }, - "repository": { + "installation": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." + }, + "repository": { + "type": "object", + "description": "A repository on GitHub." }, - "sender": { + "sender": { "type": "object", "description": "A GitHub user." }, + "workflow_job": { "type": "", "description": "" }, + "deployment": { "type": "object", - "description": "The user that triggered the event." + "description": "A request for a specific ref(branch,sha,tag) to be deployed" } }, "examples": [ - { - "action": "in_progress", - "workflow_job": { - "id": 2832853555, - "run_id": 940463255, - "run_url": "https://api.github.com/repos/octo-org/example-workflow/actions/runs/940463255", - "node_id": "MDg6Q2hlY2tSdW4yODMyODUzNT55", - "head_sha": "e3103f8eb03e1ad7f2331c5446b23c070fc54055", - "url": "https://api.github.com/repos/octo-org/example-workflow/actions/jobs/2832853555", - "html_url": "https://github.com/octo-org/example-workflow/runs/2832853555", - "status": "in_progress", - "conclusion": null, - "started_at": "2021-06-15T19:22:27Z", - "completed_at": null, - "name": "Test workflow", - "steps": [ - { - "name": "Set up job", - "status": "in_progress", - "conclusion": null, - "number": 1, - "started_at": "2021-06-15T19:22:27.000Z", - "completed_at": null - } - ], - "check_run_url": "https://api.github.com/repos/octo-org/example-workflow/check-runs/2832853555", - "labels": ["gpu", "db-app", "dc-03"], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group" - }, - "repository": { - "id": 376034443, - "node_id": "MDEwOlJlcG9zaXRvcnkzNzYwMzQ0ND55", - "name": "example-workflow", - "full_name": "octo-org/example-workflow", - "private": true, - "owner": { - "login": "octo-org", - "id": 33435655, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", - "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "html_url": "https://github.com/octo-org/example-workflow", - "description": "Test workflow", - "fork": false, - "url": "https://api.github.com/repos/octo-org/example-workflow", - "forks_url": "https://api.github.com/repos/octo-org/example-workflow/forks", - "keys_url": "https://api.github.com/repos/octo-org/example-workflow/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octo-org/example-workflow/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octo-org/example-workflow/teams", - "hooks_url": "https://api.github.com/repos/octo-org/example-workflow/hooks", - "issue_events_url": "https://api.github.com/repos/octo-org/example-workflow/issues/events{/number}", - "events_url": "https://api.github.com/repos/octo-org/example-workflow/events", - "assignees_url": "https://api.github.com/repos/octo-org/example-workflow/assignees{/user}", - "branches_url": "https://api.github.com/repos/octo-org/example-workflow/branches{/branch}", - "tags_url": "https://api.github.com/repos/octo-org/example-workflow/tags", - "blobs_url": "https://api.github.com/repos/octo-org/example-workflow/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/example-workflow/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/example-workflow/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octo-org/example-workflow/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octo-org/example-workflow/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octo-org/example-workflow/languages", - "stargazers_url": "https://api.github.com/repos/octo-org/example-workflow/stargazers", - "contributors_url": "https://api.github.com/repos/octo-org/example-workflow/contributors", - "subscribers_url": "https://api.github.com/repos/octo-org/example-workflow/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/example-workflow/subscription", - "commits_url": "https://api.github.com/repos/octo-org/example-workflow/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octo-org/example-workflow/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octo-org/example-workflow/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octo-org/example-workflow/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octo-org/example-workflow/contents/{+path}", - "compare_url": "https://api.github.com/repos/octo-org/example-workflow/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octo-org/example-workflow/merges", - "archive_url": "https://api.github.com/repos/octo-org/example-workflow/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octo-org/example-workflow/downloads", - "issues_url": "https://api.github.com/repos/octo-org/example-workflow/issues{/number}", - "pulls_url": "https://api.github.com/repos/octo-org/example-workflow/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octo-org/example-workflow/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/example-workflow/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octo-org/example-workflow/labels{/name}", - "releases_url": "https://api.github.com/repos/octo-org/example-workflow/releases{/id}", - "deployments_url": "https://api.github.com/repos/octo-org/example-workflow/deployments", - "created_at": "2021-06-11T13:29:13Z", - "updated_at": "2021-06-11T13:33:01Z", - "pushed_at": "2021-06-11T13:32:58Z", - "git_url": "git://github.com/octo-org/example-workflow.git", - "ssh_url": "git@github.com:octo-org/example-workflow.git", - "clone_url": "https://github.com/octo-org/example-workflow.git", - "svn_url": "https://github.com/octo-org/example-workflow", - "homepage": null, - "size": 1, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 0, - "license": null, - "forks": 0, - "open_issues": 0, - "watchers": 0, - "default_branch": "main" - }, - "organization": { - "login": "octo-org", - "id": 33435655, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Nj55", - "url": "https://api.github.com/orgs/octo-org", - "repos_url": "https://api.github.com/orgs/octo-org/repos", - "events_url": "https://api.github.com/orgs/octo-org/events", - "hooks_url": "https://api.github.com/orgs/octo-org/hooks", - "issues_url": "https://api.github.com/orgs/octo-org/issues", - "members_url": "https://api.github.com/orgs/octo-org/members{/member}", - "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", - "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", - "description": "octo-org" - }, - "sender": { - "login": "octocat", - "id": 319655, - "node_id": "MDQ6VXNlcjMxOTY1NQ55", - "avatar_url": "https://avatars.githubusercontent.com/u/21031067?s=460&u=d851e01410b4f1674f000ba7e0dc94e0b82cd9cc&v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - } - }, { "action": "completed", "workflow_job": { @@ -72019,345 +63153,30 @@ }, { "name": "workflow_run", - "description": "When a GitHub Actions workflow run is requested or completed. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_run).\"", - "actions": ["completed", "in_progress", "requested"], + "description": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.\n\n### Availability for `workflow_run`\n\n* Enterprises\n* Repositories\n* Organizations\n* GitHub Apps\n\n### Webhook payload object for `workflow_run`\n\nAction type: completed\n\nA workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.\n\nWebhook request body parameters\n\nName, Type, Description\n\n`action` string Required\n\nValue: `completed`\n\n`enterprise` object\n\nAn enterprise on GitHub.\n\n`installation` object\n\nThe GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.\n\n`organization` object\n\nA GitHub organization.\n\n`repository` object Required\n\nA repository on GitHub.\n\n`sender` object Required\n\nA GitHub user.\n\n`workflow` object or null Required\n\n`workflow_run` Required", + "actions": ["completed", "requested"], "properties": { - "workflow_run": { + "enterprise": { "type": "object", - "description": "The workflow run. Includes information such as `artifacts_url`, `check_suite_id`, `conclusion`, `head_branch`, and `head_sha`." + "description": "An enterprise on GitHub." }, - "workflow": { + "installation": { "type": "object", - "description": "The workflow that generated the workflow run." + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App." }, "organization": { "type": "object", - "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + "description": "A GitHub organization." }, "repository": { "type": "object", - "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred." + "description": "A repository on GitHub." }, - "sender": { - "type": "object", - "description": "The user that triggered the event." - } + "sender": { "type": "object", "description": "A GitHub user." }, + "workflow": { "type": "object or null", "description": "" }, + "workflow_run": { "type": "", "description": "" } }, "examples": [ - { - "action": "completed", - "organization": { - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "description": "", - "events_url": "https://api.github.com/orgs/Octocoders/events", - "hooks_url": "https://api.github.com/orgs/Octocoders/hooks", - "id": 33435682, - "issues_url": "https://api.github.com/orgs/Octocoders/issues", - "login": "Codertocat", - "members_url": "https://api.github.com/orgs/Octocoders/members{/member}", - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}", - "repos_url": "https://api.github.com/orgs/Octocoders/repos", - "url": "https://api.github.com/orgs/Codertocat" - }, - "repository": { - "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", - "archived": false, - "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", - "clone_url": "https://github.com/Codertocat/Hello-World.git", - "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", - "created_at": "2020-07-29T09:57:16Z", - "default_branch": "main", - "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", - "description": null, - "disabled": false, - "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", - "fork": false, - "forks": 0, - "forks_count": 0, - "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", - "full_name": "Codertocat/Hello-World", - "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", - "git_url": "git://github.com/Codertocat/Hello-World.git", - "has_downloads": true, - "has_issues": true, - "has_pages": false, - "has_projects": true, - "has_wiki": true, - "homepage": null, - "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", - "html_url": "https://github.com/Codertocat/Hello-World", - "id": 283462325, - "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", - "language": null, - "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", - "license": null, - "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", - "mirror_url": null, - "name": "Hello-World", - "node_id": "MDEwOlJlcG9zaXRvcnkyODM0NjIzMjU=", - "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", - "open_issues": 0, - "open_issues_count": 0, - "owner": { - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/Codertocat", - "id": 33435682, - "login": "Codertocat", - "node_id": "MDEyOk9yZ2FuaXphdGlvbjMzNDM1Njgy", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "site_admin": false, - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "type": "Organization", - "url": "https://api.github.com/users/Codertocat" - }, - "private": true, - "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", - "pushed_at": "2020-07-29T10:06:16Z", - "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", - "size": 0, - "ssh_url": "git@github.com:Codertocat/Hello-World.git", - "stargazers_count": 0, - "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", - "svn_url": "https://github.com/Codertocat/Hello-World", - "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", - "updated_at": "2020-07-29T10:06:18Z", - "url": "https://api.github.com/repos/Codertocat/Hello-World", - "watchers": 0, - "watchers_count": 0 - }, - "sender": { - "avatar_url": "https://avatars3.githubusercontent.com/u/54248166?v=4", - "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", - "followers_url": "https://api.github.com/users/Codertocat/followers", - "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", - "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/Codertocat", - "id": 54248166, - "login": "Codertocat", - "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", - "organizations_url": "https://api.github.com/users/Codertocat/orgs", - "received_events_url": "https://api.github.com/users/Codertocat/received_events", - "repos_url": "https://api.github.com/users/Codertocat/repos", - "site_admin": true, - "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", - "type": "User", - "url": "https://api.github.com/users/Codertocat" - }, - "workflow": { - "badge_url": "https://github.com/octo-org/octo-repo/workflows/Manually%20triggered%20workflow/badge.svg", - "created_at": "2021-12-15T20:11:38.000Z", - "html_url": "https://github.com/octo-org/octo-repo/blob/main/.github/workflows/syntax.yml", - "id": 16340987, - "name": "Manually triggered workflow", - "node_id": "W_kwDOF6lyTM4A-Vf7", - "path": ".github/workflows/syntax.yml", - "state": "active", - "updated_at": "2021-12-16T18:40:41.000Z", - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" - }, - "workflow_run": { - "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/artifacts", - "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/cancel", - "check_suite_id": 4683454167, - "check_suite_node_id": "CS_kwDOF6lyTM8AAAABFyfW1w", - "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/4683454167", - "conclusion": null, - "created_at": "2021-12-16T19:37:22Z", - "event": "workflow_dispatch", - "head_branch": "main", - "head_commit": { - "author": { "email": "octocat@github.com", "name": "Mona Lisa" }, - "committer": { "email": "noreply@github.com", "name": "GitHub" }, - "id": "5779607b49aab1200488439f02372c57b4f75444", - "message": "Update milestone-created.yml", - "timestamp": "2021-12-16T19:37:14Z", - "tree_id": "8181cee091cf9627ac07c3cc4b94c015a1d56706" - }, - "head_repository": { - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "description": null, - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "fork": false, - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "full_name": "octo-org/octo-repo", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "html_url": "https://github.com/octo-org/octo-repo", - "id": 396980812, - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "name": "octo-repo", - "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "owner": { - "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/octo-org", - "id": 79927191, - "login": "octo-org", - "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "repos_url": "https://api.github.com/users/octo-org/repos", - "site_admin": false, - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "type": "Organization", - "url": "https://api.github.com/users/octo-org" - }, - "private": true, - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "head_sha": "5779607b49aab1200488439f02372c57b4f75444", - "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1589141559", - "id": 1589141559, - "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/jobs", - "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/logs", - "name": "Manually triggered workflow", - "node_id": "WFR_kwLOF6lyTM5euGA3", - "previous_attempt_url": null, - "pull_requests": [], - "repository": { - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "description": null, - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "fork": false, - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "full_name": "octo-org/octo-repo", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "html_url": "https://github.com/octo-org/octo-repo", - "id": 396980812, - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "name": "octo-repo", - "node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "owner": { - "avatar_url": "https://avatars.githubusercontent.com/u/79927191?v=4", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "gravatar_id": "", - "html_url": "https://github.com/octo-org", - "id": 79927191, - "login": "octo-org", - "node_id": "MDEyOk9yZ2FuaXphdGlvbjc5OTI3MTkx", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "repos_url": "https://api.github.com/users/octo-org/repos", - "site_admin": false, - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "type": "Organization", - "url": "https://api.github.com/users/octo-org" - }, - "private": true, - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559/rerun", - "run_attempt": 1, - "run_number": 36, - "run_started_at": "2021-12-16T19:37:22Z", - "status": "queued", - "updated_at": "2021-12-16T19:37:22Z", - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1589141559", - "workflow_id": 16340987, - "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/16340987" - } - }, { "action": "completed", "organization": {