Summary

Add the GitHubAppWebhookHandlerHook extension hook.

Review Request #15338 — Created Sept. 24, 2026 and updated Oct. 9, 2026, 3:39 p.m.

Information

Owner

maubin

Repository

Review Board

Branch

release-9.x

Bugs

Depends On

15337

Reviewers

Groups

reviewboard

People

Description

This adds an extension hook for registering GitHub App webhook handlers,
letting extensions act on GitHub events delivered to Review Board, like
pull requests being opened on a repository.

Testing Done


Ran unit tests.
Used in the Pull Request integration work.
Built the docs and viewed.

Commits

Summary	ID
Add the GitHubAppWebhookHandlerHook extension hook. This adds an extension hook for registering GitHub App webhook handlers, letting extensions act on GitHub events delivered to Review Board, like pull requests being opened on a repository.	38345376acfed4c1ec695cfe81222e0ed6ef880b

Issues

Description	From	Last Updated
This reads like it was supposed to be .. todo::, which would show up in content. A regular rst comment …	david	Oct. 1, 2026, 1:44 p.m.
Same here.	david	Oct. 1, 2026, 1:45 p.m.
If we're using this, we should also include from __future__ import annotations in the example, otherwise any Python version less …	david	Oct. 1, 2026, 1:45 p.m.
Missing a trailing comma.	david	Oct. 1, 2026, 1:46 p.m.
Can we prefix this name with an underscore (so pytest doesn't get annoyed trying to collect it), and add a …	david	Oct. 1, 2026, 1:47 p.m.
I don't think there's any reason for this to use GitHubTestCase, and it's pulling in setup work for no good …	david	Oct. 1, 2026, 1:51 p.m.
We should probably use assertIs instead of assertEqual	david	Oct. 1, 2026, 1:52 p.m.
Everywhere else we've tried to be careful to capitalize this "WebHook". We should do that throughout here, and also in …	david	Oct. 8, 2026, 5:48 p.m.
This suggests that all 5 attributes are required, but only two are. Can we do: You must set the following: …	david	Oct. 8, 2026, 5:36 p.m.
installation_account can also be None	david	Oct. 8, 2026, 5:48 p.m.
Needs a trailing comma.	david	Oct. 8, 2026, 5:38 p.m.

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 1)

The issue has been resolved. Show all issues

This reads like it was supposed to be .. todo::, which would show up in content. A regular rst comment with "TODO" might be better, as opposed to something that looks like a typoed directive.

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 1)

The issue has been resolved. Show all issues

Same here.

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 1)

The issue has been resolved. Show all issues

If we're using this, we should also include from __future__ import annotations in the example, otherwise any Python version less than 3.14 will get a NameError

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing a trailing comma.
```
reviewboard/extensions/tests/test_github_app_webhook_handler_hook.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we prefix this name with an underscore (so pytest doesn't get annoyed trying to collect it), and add a docstring?
```

reviewboard/extensions/tests/test_github_app_webhook_handler_hook.py (Diff revision 1)

The issue has been resolved. Show all issues

I don't think there's any reason for this to use GitHubTestCase, and it's pulling in setup work for no good reason. BaseExtensionHookTestCase is a better base class to use.

reviewboard/extensions/tests/test_github_app_webhook_handler_hook.py (Diff revision 1)

The issue has been resolved. Show all issues

We should probably use assertIs instead of assertEqual

Commits:

	Summary	ID
	Add the GitHubAppWebhookHandlerHook extension hook. This adds an extension hook for registering GitHub App webhook handlers, letting extensions act on GitHub events delivered to Review Board, like pull requests being opened on a repository.	daa4bb6bcd1aaa97ae014f0499b034afa6dfabbe
	Add the GitHubAppWebhookHandlerHook extension hook. This adds an extension hook for registering GitHub App webhook handlers, letting extensions act on GitHub events delivered to Review Board, like pull requests being opened on a repository.	58235ea61b420a519e3b658f43958657288b04ff

Depends On:

15337 - Request the events/permissions of GitHub webhook handlers on app creation.

Diff:

Revision 2 (+526)

Show changes

	docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst
	docs/manual/extending/extensions/hooks/index.rst
	reviewboard/extensions/hooks/__init__.py
	reviewboard/extensions/hooks/github_app_webhook.py
	reviewboard/extensions/tests/test_github_app_webhook_handler_hook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 2)

The issue has been dropped. Show all issues

Everywhere else we've tried to be careful to capitalize this "WebHook". We should do that throughout here, and also in GitHubAppWebHookHandlerHook

maubin

Oct. 8, 2026, 5:48 p.m.

I'll do this in a separate change and update the other new webhook things that were added in 9.0 that use Webhook instead of WebHook.

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 2)

The issue has been resolved. Show all issues

This suggests that all 5 attributes are required, but only two are. Can we do:

You must set the following:

* :py:attr:`~BaseGitHubAppWebhookHandler.handler_id`: ...
* :py:attr:`~BaseGitHubAppWebhookHandler.events`: ...

You can optionally set the following:

* ...

maubin

Oct. 8, 2026, 5:48 p.m.

While we don't validate them as required when registering the class, I do want to instruct extension authors to explicitly set all these attributes so its clear what's required by the handler. I'll update the docs to be more clear about when its ok to leave some of these as blank.

docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst (Diff revision 2)

The issue has been resolved. Show all issues

installation_account can also be None

reviewboard/extensions/tests/test_github_app_webhook_handler_hook.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs a trailing comma.
```

Commits:

	Summary	ID
	Add the GitHubAppWebhookHandlerHook extension hook. This adds an extension hook for registering GitHub App webhook handlers, letting extensions act on GitHub events delivered to Review Board, like pull requests being opened on a repository.	58235ea61b420a519e3b658f43958657288b04ff
	Add the GitHubAppWebhookHandlerHook extension hook. This adds an extension hook for registering GitHub App webhook handlers, letting extensions act on GitHub events delivered to Review Board, like pull requests being opened on a repository.	38345376acfed4c1ec695cfe81222e0ed6ef880b

Diff:

Revision 3 (+540)

Show changes

	docs/manual/extending/extensions/hooks/github-app-webhook-handler-hook.rst
	docs/manual/extending/extensions/hooks/index.rst
	reviewboard/extensions/hooks/__init__.py
	reviewboard/extensions/hooks/github_app_webhook.py
	reviewboard/extensions/tests/test_github_app_webhook_handler_hook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```