github - Webhooks 可以与 GitHub OAuth 应用程序一起使用吗？

Question

所以我一直在阅读 GitHub 开发人员文档和关于 webhooks 他们有以下声明:

Webhooks allow you to build or set up GitHub Apps which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.

但是，关于应用程序，他们也有这样的声明:

Apps on GitHub extend and improve existing workflows. People can purchase apps from GitHub Marketplace or browse useful tools and services that integrate with GitHub in Works with GitHub.

If you're building or adding integrations, this documentation will help get you up and running.

For support requests, bug reports, and discussions related to GitHub Apps (not OAuth Apps), use the GitHub Platform Forum. The forum allows you to collaborate with other integrators as well as engineers and product managers from GitHub.

If your request is about OAuth Apps, or if you need to discuss a private concern, please contact support directly.

这似乎 Webhooks 只能与 GitHub Apps 一起使用？ GitHub 应用程序和 GitHub OAuth 应用程序之间的区别不是很清楚，我不明白为什么 OAuth 应用程序不能使用 Webhooks？

Answer 1

编辑

Can Webhooks be used with a GitHub OAuth App?

是的。

Webhooks allow you to build or set up GitHub Apps which subscribe to certain events on GitHub.com.

这是一个不正确的说法。这应该是“与 GitHub 的集成”而不是“GitHub 应用程序”。

This seems that Webhooks can only be used with GitHub Apps?

不会。GitHub 应用程序包含对 Webhooks 的隐式支持。 OAuth 应用程序请求 token 的范围为 write:repo_hook或 admin:org_hook至 register a Webhook on the Repository or Organization .

有指南 creating webhooks建议到 use the repo hooks or org hooks API endpoints .

The difference between GitHub Apps and GitHub OAuth Apps isn't very clear and I fail to see why an OAuth app would not be able to use Webhooks?

有文档描述 some differences between GitHub Apps and OAuth Apps.

GitHub Apps 的 TLDR 优势:

Granular Permissions

Option to use short-lived Tokens

GitHub 应用程序不需要向存储库或组织添加 Webhook

避免拥有机器/服务帐户用户

原来的

Webhooks允许您的服务器/应用程序在发生特定事件时收到通知 - 无论您使用的是 OAuth 还是 GitHub 应用程序。然后，您的应用程序将需要处理 event并采取相应的行动。

另外，您的应用程序将需要与 GitHub 的 API 交互以创建、读取、编辑或删除信息。 GitHub 通常需要 credentials访问或更新特定信息。 GitHub 的 API 身份验证可以使用多种方法:

无

基本身份验证(用户名/密码)

OAuth2 token

Personal Access Token (PAT)

Installation Access Token

旧的 GitHub 集成和 GitHub 应用程序之间还有其他差异。

较旧的集成基于 Oauth2 并使用与用户帐户关联的 token 。集成将代表用户与 GitHub 的 API 交互——这就是为什么一些组织会设置 machine user .还需要显式添加 Webhook。

GitHub Apps 将代表自己与 GitHub 的 API 进行交互。您必须明确授予 GitHub 应用程序对组织或存储库的访问权限，以启用 Webhook 和 API 访问权限。