Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Esta versão do GitHub Enterprise foi descontinuada em 2021-03-02. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

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.

As contas empresariais estão disponíveis com GitHub Enterprise Cloud e GitHub Enterprise Server.

Webhooks configurados em contas corporativas ou organizações que fazem parte de uma conta corporativa incluirão um objeto da conta enterprise.

Neste artigo

Ao configurar um webhook, você pode usar a interface do usuário ou API para escolher quais eventos enviarão cargas. Assinar apenas os eventos específicos que pretende gerenciar limita o número de solicitações HTTP para o seu servidor. Você também pode assinar todos os eventos atuais e futuros. Por padrão, os webhooks são apenas inscritos no evento de push. Você pode alterar a lista de eventos assinados a qualquer momento.

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
actionstringMost webhook payloads contain an action property that contains the specific activity that triggered the event.
remetenteobjetoO usuário que ativou o evento. This property is included in every webhook payload.
repositórioobjetoO repositório em que o evento ocorreu. Webhook payloads contain the repository property when the event occurs from activity in a repository.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub. For more information, see "Building aplicativo GitHub."

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-DeliveryA GUID to identify the delivery.
X-GitHub-Enterprise-VersionThe version of the GitHub Enterprise Server instance that sent the HTTP POST payload.
X-GitHub-Enterprise-HostThe hostname of the GitHub Enterprise Server instance that sent the HTTP POST payload.
X-Hub-SignatureThis 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.

Also, the User-Agent for the requests will have the prefix GitHub-Hookshot/.

Example delivery

> POST /payload HTTP/1.1

> 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: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues

> {
>   "action": "opened",
>   "issue": {
>     "url": "http(s)://[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,
>     ...
>   }
> }

check_run

Verifique se a atividade de execução ocorreu. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "execuções de verificação".

Nota: A API Checks procura apenas por pushes no repositório onde o conjunto de verificação ou execução de verificação foram criadas. Pushes para um branch em um repositório bifurcado não foi detectado e retorna um array pull_requests vazio e um valor null para 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
  • aplicativo GitHubs with the 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 the 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 aplicativo GitHub being requested. aplicativo GitHubs with the checks:write are automatically subscribed to this webhook event.

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada. Pode ser uma das ações a seguir:
  • created - Uma nova execução de verificação foi criada.
  • completed - O status da execução da verificação está completed.
  • rerequested - Alguém pediu para executar novamente sua verificação a partir da interface de usuário do pull request. Veja "Sobre verificações de status" para mais informações sobre a interface do usuário do GitHub. When you receive a rerequested action, you'll need to create a new check run. Apenas o aplicativo GitHub que alguém solicitar para repetir a verificação receberá a carga rerequested.
  • requested_action - Alguém solicitou novamente que se tome uma ação fornecida pelo seu aplicativo. Apenas o aplicativo GitHub para o qual alguém solicitou uma ação receberá a carga requested_action. To learn more about check runs and requested actions, see "Check runs and requested actions."
check_runobjetoO check_run.
check_run[status]stringO status atual da execução da verificação. Pode ser queued, in_progress ou completed.
check_run[conclusion]stringO resultado da execução de verificação concluída. Pode ser: success, failure, neutral, cancelled, timed_out, action_required ou stale. Este valor será null até que a execução da verificação seja completed.
check_run[name]stringO nome da execução da verificação.
check_run[check_suite][id]inteiroA identificação do conjunto de verificações do qual a execução de verificação faz parte.
check_run[check_suite][pull_requests]arrayUm array de pull requests que correspondem a este conjunto de verificações. Um pull request corresponde a um conjunto de verificações se tiverem os mesmos head_sha e head_branch. Quando o head_branch do conjunto de verificações estiver em um repositório bifurcado, ele será null e o array pull_requests ficará vazio.
requested_actionobjetoA ação solicitada pelo usuário.
requested_action[identifier]stringA referência de integrador da ação solicitada pelo usuário.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Ocorreu uma atividade de conjuntos de verificações. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de"conjunto de verificações".

Nota: A API Checks procura apenas por pushes no repositório onde o conjunto de verificação ou execução de verificação foram criadas. Pushes para um branch em um repositório bifurcado não foi detectado e retorna um array pull_requests vazio e um valor null para 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
  • aplicativo GitHubs with the 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 the checks:write permission to receive the requested and rerequested event types. The requested and rerequested event type payloads are only sent to the aplicativo GitHub being requested. aplicativo GitHubs with the checks:write are automatically subscribed to this webhook event.

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada. Pode ser:
  • completed - Todas as verificações executadas em um conjunto de verificações foram concluídas.
  • requested - Ocorre quando o novo código é carregado para o repositório do aplicativo. When you receive the requested action events, you'll need to create a new check run.
  • rerequested - Ocorre quando alguém solicita uma nova execução de todo o conjunto de verificação da interface de usuário do pull request. When you receive the rerequested action events, you'll need to create a new check run. Veja "Sobre verificações de status" para mais informações sobre a interface do usuário do GitHub.
check_suiteobjetoO check_suite.
check_suite[head_branch]stringO nome do branch principal em que as alterações se encontram.
check_suite[head_sha]stringA SHA do commit mais recente para este conjunto de verificações.
check_suite[status]stringO status de resumo para todas as verificações que fazem parte do conjunto de verificações. Pode ser requested, in_progress ou completed.
check_suite[conclusion]stringO resumo da conclusão para todas as verificações que fazem parte do conjunto de verificações. Pode ser: success, failure, neutral, cancelled, timed_out, action_required ou stale. Este valor será null até que a execução da verificação seja completed.
check_suite[url]stringA URL que aponta para o recurso da API do conjunto de verificações.
check_suite[pull_requests]arrayUm array de pull requests que correspondem a este conjunto de verificações. Um pull request corresponde a um conjunto de verificações se tiverem os mesmos head_sha e head_branch. Quando o head_branch do conjunto de verificações estiver em um repositório bifurcado, ele será null e o array pull_requests ficará vazio.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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=="
  }
}

content_reference

Uma nova referência de conteúdo foi criada. Uma nova referência de conteúdo é criada quando o texto ou comentário de um problema ou pull request inclui uma URL que corresponde a um domínio de referência de conteúdo configurado. Para obter mais informações, consulte "Usar anexos de conteúdo" para saber mais sobre referências de conteúdo e anexos.

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.

Only aplicativo GitHubs can receive this event. aplicativo GitHubs must have the content_references write permission to subscribe to this event.

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"
  }
}

create

Um branch ou tag do Git é criado. Para obter mais informações, consulte a API REST de "dados do Git.

Note: You will not receive a webhook for this event when you push more than three tags at once.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the contents permission

Webhook payload object

TeclaTipoDescrição
refstringO recurso ref do git.
ref_typestringO tipo de objeto de ref do Git criado no repositório. Pode ser branch ou tag.
master_branchstringO nome do branch-padrão do repositório (normalmente principal).
descriçãostringDescrição atual do repositório.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Um branch ou tag do Git é excluído. Para obter mais informações, consulte a API REST de "dados do Git.

Note: You will not receive a webhook for this event when you delete more than three tags at once.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the contents permission

Webhook payload object

TeclaTipoDescrição
refstringO recurso ref do git.
ref_typestringO tipo de objeto do Git ref excluído no repositório. Pode ser branch ou tag.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Uma chave de implementação foi adicionada ou removida de um repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "Chaves de implementação".

Availability

  • Repository webhooks
  • Organization webhooks

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada. Pode ser criado ou excluído.
ChaveobjetoO recurso de implantar chave.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
remetenteobjetoO usuário que ativou o evento.

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

Uma implantação foi criada. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST "implantação".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the deployments permission

Webhook payload object

KeyTypeDescription
deploymentobjectThe deployment.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Uma implantação foi criada. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST do "status de implantação".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the deployments permission

Webhook payload object

KeyTypeDescription
deployment_statusobjectThe deployment status.
deployment_status["state"]stringThe new state. Can be pending, success, failure, or error.
deployment_status["target_url"]stringThe optional link added to the status.
deployment_status["description"]stringThe optional human-readable description added to the status.
deploymentobjectThe deployment that this status is associated with.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Um site ou administrador de repositório habilita ou desabilita o acesso de leitura anônimo do Git. Consulte "Permitir que administradores habilitem acesso de leitura anônimo do Git aos repositórios públicos" para obter mais informações. Este evento não está disponível na API de eventos.

Availability

Webhook payload object

KeyTypeDescription
actionstringThe 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

Um usuário bifurca um repositório. Para obter mais informações, consulte a API REST de bifurcações".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the contents permission

Webhook payload object

TeclaTipoDescrição
forkeeobjetoO recurso do repositório criado.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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 aplicativo GitHub, this event occurs. A aplicativo GitHub receives this webhook by default and cannot unsubscribe from this event.

Qualquer pessoa pode revogar a autorização de um aplicativo GitHub a partir da sua página de configurações de conta do GitHub. Revogar a autorização de um aplicativo GitHub não desinstala o aplicativo GitHub. Você deve programar seu aplicativo do GitHub para que, ao receber esse webhook, ele para de chamar a API em nome da pessoa que revogou o token. Se o seu aplicativo GitHub continuar usando um token de acesso revogado, ele receberá a mensagem de erro 401 Bad Credentials. For details about user-to-server requests, which require aplicativo GitHub authorization, see "Identifying and authorizing users for aplicativo GitHubs."

Availability

  • aplicativo GitHubs

Webhook payload object

KeyTypeDescription
actionstringThe action performed. Can be revoked.
remetenteobjetoO usuário que ativou o evento.

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

Uma página wiki foi criada ou atualizada. Para obter mais informações, consulte "Sobre wikis".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the contents permission

Webhook payload object

TeclaTipoDescrição
PáginasarrayAs páginas que foram atualizadas.
pages[][page_name]stringO nome da página.
pages[][title]stringO título da página atual.
pages[][action]stringA ação que foi realizada na página. Pode ser criado ou editado.
pages[][sha]stringO SHA de commit mais recente da página.
pages[][html_url]stringAponta para a página wiki de HTML.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a uma instalação do aplicativo GitHub. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST da "Instalação do aplicativo GitHub".

Note: This event replaces the deprecated integration_installation event.

Availability

  • aplicativo GitHubs

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser uma das ações a seguir:
  • created - Alguém instala um aplicativo GitHub.
  • deleted - Alguém desinstala aplicativo GitHub
  • new_permissions_accepted - Alguém aceita novas permissões para uma instalação de aplicativo GitHub. Quando um proprietário de aplicativo GitHub solicita novas permissões, a pessoa que instalou o aplicativo GitHub deve aceitar a nova solicitação de permissões.
repositoriesarrayUma matriz de objetos do repositório que a instalação pode acessar.
instalaçãoobjetoA instalação de aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada aos repositórios adicionados a uma instalação do aplicativo GitHub. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST da "Instalação do aplicativo GitHub".

Note: This event replaces the deprecated integration_installation_repositories event.

Availability

  • aplicativo GitHubs

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser adicionado ou removido.
repository_selectionstringA escolha dos repositórios em que a instalação se encontra. Pode ser selecionado ou todos.
repositories_addedarrayUma matriz de objetos do repositório adicionados à instalação.
repositories_removedarrayUm array de objetos do repositório removidos da instalação.
instalaçãoobjetoA instalação de aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a um comentário de um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentários de problema".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the issues permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada no comentário. Pode ser created, edited ou deleted.
alteraçõesobjeto As alterações no comentário se a ação foi editada. alterações[body][from]stringA versão anterior do texto se a ação foi editada. problemaobjeto ├O problema ao qual o comentário pertence. comentário
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST de problemas".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the issues permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser opened, edited, deleted, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, locked, unlocked, transferred, milestoned ou demilestoned.
problemaobjetoO próprio problema. alterações
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte API REST de etiquetas".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the metadata permission

Webhook payload object

KeyTypeDescription
actionstringThe action that was performed. Can be created, edited, or deleted.
labelobjectThe label that was added.
changesobjectThe changes to the label if the action was edited.
changes[name][from]stringThe previous version of the name if the action was edited.
changes[color][from]stringThe previous version of the color if the action was edited.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada aos colaboradores do repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST dos colaboradores".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the members permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser uma das ações a seguir:
  • added - Um usuário aceita um convite para um repositório.
  • removed - Um usuário é removido como colaborador de um repositório.
  • edited - As permissões de um colaborador do usuário foram alteradas.
integranteobjetoO usuário que foi adicionado. alterações
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada à associação na equipe. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos integrantes da equipe".

Availability

  • Organization webhooks
  • aplicativo GitHubs with the members permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser adicionado ou removido.
escopostringO escopo da associação. Atualmente, só pode ser equipe.
integranteobjetoO usuário que foi adicionado ou removido.
equipeobjetoA equipe para a associação.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

KeyTypeDescription
actionstringThe action performed. Can be deleted.
hook_idintegerThe id of the modified webhook.
hookobjectThe modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada aos marcos. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos marcos".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the pull_requests permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser created, closed, opened, edited ou deleted.
marcoobjetoO próprio marco.
alteraçõesobjetoAs alterações para o marco se a ação foi editada.
changes[description][from]stringA versão anterior da descrição se a ação foi editada.
changes[due_on][from]stringA versão anterior da data de vencimento se a ação foi editada.
changes[title][from]stringA versão anterior do título se a ação foi editada.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a uma organização e seus integrantes. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APRI REST de "organizações".

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
  • aplicativo GitHubs with the members permission

Webhook payload object

KeyTypeDescription
actionstringThe action that was performed. Can be one of: created, deleted, renamed, member_added, member_removed, or member_invited.
invitationobjectThe invitation for the user or email if the action is member_invited.
membershipobjectThe membership between the user and the organization. Not present when the action is member_invited.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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
  }
}

page_build

Representa uma tentativa de criação de um site do GitHub Pages, independentemente de êxito. Um push para um branch habilitado de GitHub Pages (gh-pages para páginas de projeto, o branch-padrão para páginas de usuário e organização) aciona este evento.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the pages permission

Webhook payload object

KeyTypeDescription
idintegerThe unique identifier of the page build.
buildobjectThe List GitHub Pages builds itself.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Ao criar um novo webhook, enviaremos um simples evento de ping para informar que você configurou o webhook corretamente. Este evento não é armazenado. Portanto, não é recuperável através do ponto de extremidade da API de Eventos.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs 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.
hookobjectThe webhook configuration.
hook[app_id]integerWhen you register a new aplicativo GitHub, 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.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
remetenteobjetoO usuário que ativou o evento.

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_card

Atividade relacionada aos cartões do projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos cartões de projeto".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the repository_projects or organization_projects permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada no cartão do projeto. Pode ser created, edited, moved, converted ou deleted.
alteraçõesobjetoAs alterações no cartão do projeto se a ação foi editada ou convertida.
changes[note][from]stringA versão anterior da nota se a ação foi editada ou convertida.
after_idinteiroO ID do cartão que este cartão agora segue se a ação foi "movida". Será nulo se for o primeiro cartão em uma coluna.
project_cardobjetoO próprio cartão do projeto.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a colunas em um quadro de projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST das "colunas do projeto".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the repository_projects or organization_projects permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada na coluna do projeto. Pode ser created, edited, moved ou deleted.
alteraçõesobjetoAs alterações na coluna do projeto, se a ação foi editada.
changes[name][from]stringA versão anterior do nome se a ação foi editada.
after_idinteiroO id da coluna que esta coluna agora segue se a ação foi "movida". Será nulo se for a primeira coluna em um projeto.
project_columnobjetoA própria coluna do projeto.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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=="
  }
}

project

Atividade relacionada aos quadros de projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte A API REST dos "projetos".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the repository_projects or organization_projects permission

Webhook payload object

TeclaTipoDescrição
AçãostringA acção que foi realizada no projeto. Pode ser created, edited, closed, reopened ou deleted.
alteraçõesobjetoAs alterações no projeto, se a ação foi editada.
changes[name][from]stringA versão anterior do nome se a ação foi editada.
changes[body][from]stringA versão anterior do texto se a ação foi editada.
projectobjetoO próprio projeto.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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=="
  }
}

public

Quando um repositório privado torna-se público. Sem dúvida: o melhor evento de GitHub Enterprise Server.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the metadata permission

Webhook payload object

KeyTypeDescription
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a pull requests. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "pull requests".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the pull_requests permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Can be one of opened, edited, closed, assigned, unassigned, review_requested, review_request_removed, ready_for_review, converted_to_draft, labeled, unlabeled, synchronize, locked, unlocked, or reopened. Se a ação é closed e a chave merged é false, o pull request foi fechado com commits não mesclados. Se a ação for closed e a chave merged for verdadeira, o pull request foi mesclado.
númerointeiroO número do pull request. alterações
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a revisões de pull request. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST "Revisões de pull request".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the pull_requests permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser uma das ações a seguir:
  • submitted - Uma revisão de pull request é enviada em um estado não pendente.
  • edited - O texto de uma revisão foi editado.
  • dimissed - Uma revisão foi descartada.
pull_requestobjetoO pull request ao qual a revisão pertence.
revisarobjetoA revisão que foi afetada.
changes[body][from]stringA versão anterior do texto se a ação foi editada.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada aos comentários de revisão do pull request no diff unificado do pull request. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos "comentários de revisão de pull request".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the pull_requests permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada no comentário. Pode ser created, edited ou deleted.
alteraçõesobjetoAs alterações no comentário se a ação foi editada. alterações[body][from]
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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 emojji 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=="
  }
}

push

Um ou mais commits são enviados para uma branch ou tag de um repositório.

Note: You will not receive a webhook for this event when you push more than three tags at once.

Note: The webhook payload example following the table differs significantly from the Events API payload described in the table. Among other differences, the webhook payload includes both sender and pusher objects. Sender and pusher are the same user who initiated the push event, but the sender object contains more detail.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the contents permission

Webhook payload object

KeyTypeDescription
refstringThe full git ref that was pushed. Example: refs/heads/main.
beforestringThe SHA of the most recent commit on ref before the push.
afterstringThe SHA of the most recent commit on ref after the push.
commitsarrayAn array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
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]booleanWhether this commit is distinct from any that have been pushed before.
commits[][added]arrayAn array of files added in the commit.
commits[][modified]arrayAn array of files modified by the commit.
commits[][removed]arrayAn array of files removed in the commit.
pusherobjectThe user who pushed the commits.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a uma versão. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST das versões".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the contents permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser uma das ações a seguir:
  • published: uma versão, pré-versão ou rascunho de uma versão foi publicada
  • unpublished: uma versão ou pré-versão foi excluída
  • created: um rascunho foi salvo, ou uma versão ou pré-versão foi publicada sem ser previamente salva como rascunho
  • edited: uma versão, pré-versão ou rascunho de versão de foi editada
  • deleted: uma versão, pré-versão ou rascunho de versão foi excluído
  • prereleased: uma pré-versão foi criada
  • released: uma versão ou rascunho de uma versão foi publicado ou uma pré-versão foi alterada para uma versão
alterações[body][from]stringA versão anterior do texto se a ação foi editada. changes[name][from]
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Atividade relacionada a um repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dosrepositórios".

Availability

  • Repository webhooks receive all event types except deleted
  • Organization webhooks
  • aplicativo GitHubs with the metadata permission receive all event types except deleted

Webhook payload object

KeyTypeDescription
actionstringThe 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.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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=="
  }
}

security_advisory

Activity related to a security advisory. A security advisory provides information about security-related vulnerabilities in software on GitHub. The security advisory dataset also powers the GitHub security alerts, see "About security alerts for vulnerable dependencies."

Availability

  • aplicativo GitHubs with the security_events permission

Webhook payload object

KeyTypeDescription
actionstringThe action that was performed. The action can be one of published, updated, or performed for all new events.
security_advisoryobjectThe 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

Atividade relacionada a um repositório marcado com uma estrela. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "marcar com uma estrela".

Availability

  • Repository webhooks
  • Organization webhooks

Webhook payload object

TeclaTipoDescrição
AçãostringA ação realizada. Pode ser criado ou excluído.
starred_atstringO momento em que a estrela foi criada. Este é um registro de hora no formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ. Será nulo para a ação excluída.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
remetenteobjetoO usuário que ativou o evento.

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

Quando o status de um commit do Git é alterado. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "status".

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the statuses permission

Webhook payload object

KeyTypeDescription
idintegerThe unique identifier of the status.
shastringThe Commit SHA.
statestringThe new state. Can be pending, success, failure, or error.
descriptionstringThe optional human-readable description added to the status.
target_urlstringThe optional link added to the status.
branchesarrayAn 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.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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=="
  }
}

team

Atividade relacionada à equipe de uma organização. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "equipes".

Availability

  • Organization webhooks
  • aplicativo GitHubs with the members permission

Webhook payload object

KeyTypeDescription
actionstringThe action that was performed. Can be one of created, deleted, edited, added_to_repository, or removed_from_repository.
teamobjectThe team itself.
changesobjectThe changes to the team if the action was edited.
changes[description][from]stringThe previous version of the description if the action was edited.
changes[name][from]stringThe previous version of the name if the action was edited.
changes[privacy][from]stringThe previous version of the team's privacy if the action was edited.
changes[repository][permissions][from][admin]booleanThe previous version of the team member's admin permission on a repository, if the action was edited.
changes[repository][permissions][from][pull]booleanThe previous version of the team member's pull permission on a repository, if the action was edited.
changes[repository][permissions][from][push]booleanThe previous version of the team member's push permission on a repository, if the action was edited.
repositoryobjectThe 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.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
remetenteobjetoO usuário que ativou o evento.

Webhook payload example

team_add

Quando um repositório é adicionado a uma equipe.

Availability

  • Repository webhooks
  • Organization webhooks
  • aplicativo GitHubs with the members permission

Webhook payload object

KeyTypeDescription
teamobjectThe team that was modified. Note: Older events may not include this in the payload.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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

Webhook payload example

watch

Quando alguém marca um repositório com uma estrela. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "marcar com uma estrela".

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
  • aplicativo GitHubs with the metadata permission

Webhook payload object

TeclaTipoDescrição
AçãostringA ação que foi executada. Atualmente, só pode ser favoritada.
repositórioobjetoO repositório em que o evento ocorreu.
organizaçãoobjeto Cargas do webhook contêm o objeto da organização quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
instalaçãoobjetoA instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade instalação quando o evento é configurado para um aplicativo GitHub.
remetenteobjetoO usuário que ativou o evento.

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=="
  }
}