Octokit.Webhooks.AspNetCore
3.2.1
Prefix Reserved
dotnet add package Octokit.Webhooks.AspNetCore --version 3.2.1
NuGet\Install-Package Octokit.Webhooks.AspNetCore -Version 3.2.1
<PackageReference Include="Octokit.Webhooks.AspNetCore" Version="3.2.1" />
<PackageVersion Include="Octokit.Webhooks.AspNetCore" Version="3.2.1" />
<PackageReference Include="Octokit.Webhooks.AspNetCore" />
paket add Octokit.Webhooks.AspNetCore --version 3.2.1
#r "nuget: Octokit.Webhooks.AspNetCore, 3.2.1"
#:package Octokit.Webhooks.AspNetCore@3.2.1
#addin nuget:?package=Octokit.Webhooks.AspNetCore&version=3.2.1
#tool nuget:?package=Octokit.Webhooks.AspNetCore&version=3.2.1
Octokit.Webhooks
Libraries to handle GitHub Webhooks in .NET applications.
Usage
ASP.NET Core
dotnet add package Octokit.Webhooks.AspNetCore
Create a class that derives from
WebhookEventProcessor
and override any of the virtual methods to handle webhooks from GitHub. For example, to handle Pull Request webhooks:public sealed class MyWebhookEventProcessor : WebhookEventProcessor { protected override ValueTask ProcessPullRequestWebhookAsync( WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action, CancellationToken cancellationToken = default) { ... } }
Register your implementation of
WebhookEventProcessor
:builder.Services.AddSingleton<WebhookEventProcessor, MyWebhookEventProcessor>();
Map the webhook endpoint:
app.UseEndpoints(endpoints => { ... endpoints.MapGitHubWebhooks(); ... });
MapGitHubWebhooks()
takes two optional parameters:
path
. Defaults to/api/github/webhooks
, the URL of the endpoint to use for GitHub.secret
. The secret you have configured in GitHub, if you have set this up.
Azure Functions
NOTE: Support is only provided for isolated process Azure Functions.
dotnet add package Octokit.Webhooks.AzureFunctions
Create a class that derives from
WebhookEventProcessor
and override any of the virtual methods to handle webhooks from GitHub. For example, to handle Pull Request webhooks:public sealed class MyWebhookEventProcessor : WebhookEventProcessor { protected override ValueTask ProcessPullRequestWebhookAsync( WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action, CancellationToken cancellationToken = default) { ... } }
Register your implementation of
WebhookEventProcessor
:.ConfigureServices(collection => { ... collection.AddSingleton<WebhookEventProcessor, MyWebhookEventProcessor>(); ... })
Configure the webhook function:
new HostBuilder() ... .ConfigureGitHubWebhooks() ... .Build();
ConfigureGitHubWebhooks()
either takes an optional parameter:
secret
. The secret you have configured in GitHub, if you have set this up.
or:
configure
. A function that takes an IConfiguration instance and expects the secret you have configured in GitHub in return.
The function is available on the /api/github/webhooks
endpoint.
Thanks
License
All packages in this repository are licensed under the MIT license.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- Octokit.Webhooks (>= 3.2.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Octokit.Webhooks.AspNetCore:
Package | Downloads |
---|---|
MintPlayer.SlingBot
Build a Github Bot |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Octokit.Webhooks.AspNetCore:
Repository | Stars |
---|---|
microsoft/project-oagents
Experimental AI Agents Framework
|
Version | Downloads | Last Updated |
---|---|---|
3.2.1 | 4,166 | 9/11/2025 |
3.1.0 | 2,266 | 9/2/2025 |
3.0.0 | 5,565 | 7/18/2025 |
2.5.1 | 6,697 | 6/26/2025 |
2.5.0 | 391 | 6/26/2025 |
2.4.1 | 47,050 | 10/22/2024 |
2.4.0 | 6,068 | 10/9/2024 |
2.3.0 | 1,522 | 10/2/2024 |
2.2.3 | 9,606 | 7/31/2024 |
2.2.2 | 6,250 | 6/27/2024 |
2.2.1 | 7,488 | 5/9/2024 |
2.2.0 | 679 | 5/6/2024 |
2.1.1 | 8,272 | 2/29/2024 |
2.1.0 | 6,241 | 12/19/2023 |
2.0.6 | 6,064 | 11/12/2023 |
2.0.5 | 2,024 | 10/26/2023 |
2.0.4 | 1,640 | 10/12/2023 |
2.0.3 | 7,175 | 8/25/2023 |
2.0.2 | 3,304 | 8/16/2023 |
2.0.1 | 2,627 | 6/13/2023 |
2.0.0 | 584 | 6/9/2023 |
1.5.2 | 3,281 | 6/1/2023 |
1.5.1 | 1,542 | 4/27/2023 |
1.5.0 | 411 | 4/25/2023 |
1.4.1 | 711 | 4/11/2023 |
1.4.0 | 234 | 4/6/2023 |
1.3.5 | 14,242 | 10/13/2022 |
1.3.4 | 346 | 10/5/2022 |
1.3.3 | 8,494 | 8/11/2022 |
1.3.2 | 228 | 8/9/2022 |
1.3.1 | 1,012 | 7/20/2022 |
1.3.0 | 196 | 7/19/2022 |
1.2.1 | 3,819 | 7/7/2022 |
1.2.0 | 220 | 7/7/2022 |
1.1.1 | 804 | 6/27/2022 |
1.1.0 | 385 | 6/13/2022 |
1.0.0 | 1,663 | 5/13/2022 |
0.6.5 | 575 | 4/27/2022 |
0.6.4 | 363 | 4/13/2022 |
0.6.3 | 2,199 | 3/31/2022 |
0.6.2 | 305 | 3/26/2022 |
0.6.1 | 246 | 3/25/2022 |
0.6.0 | 286 | 2/2/2022 |
0.5.0 | 766 | 1/24/2022 |
0.4.0 | 565 | 1/13/2022 |
0.3.0 | 6,028 | 11/23/2021 |
0.2.0 | 228 | 10/29/2021 |
0.1.2 | 298 | 9/27/2021 |
0.1.1 | 715 | 9/21/2021 |