Octokit.Webhooks
2.4.1
Prefix Reserved
dotnet add package Octokit.Webhooks --version 2.4.1
NuGet\Install-Package Octokit.Webhooks -Version 2.4.1
<PackageReference Include="Octokit.Webhooks" Version="2.4.1" />
paket add Octokit.Webhooks --version 2.4.1
#r "nuget: Octokit.Webhooks, 2.4.1"
// Install Octokit.Webhooks as a Cake Addin #addin nuget:?package=Octokit.Webhooks&version=2.4.1 // Install Octokit.Webhooks as a Cake Tool #tool nuget:?package=Octokit.Webhooks&version=2.4.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 Task ProcessPullRequestWebhookAsync(WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action) { ... } }
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 Task ProcessPullRequestWebhookAsync(WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action) { ... } }
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 | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
-
net6.0
- Macross.Json.Extensions (>= 3.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Octokit.Webhooks:
Package | Downloads |
---|---|
Octokit.Webhooks.AspNetCore
GitHub webhook events toolset for .NET |
|
Octokit.Webhooks.AzureFunctions
GitHub webhook events toolset for Azure Functions |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.4.1 | 8,476 | 10/22/2024 |
2.4.0 | 5,192 | 10/9/2024 |
2.3.0 | 1,517 | 10/2/2024 |
2.2.3 | 8,555 | 7/31/2024 |
2.2.2 | 7,016 | 6/27/2024 |
2.2.1 | 7,947 | 5/9/2024 |
2.2.0 | 713 | 5/6/2024 |
2.1.1 | 8,615 | 2/29/2024 |
2.1.0 | 6,261 | 12/19/2023 |
2.0.6 | 5,489 | 11/12/2023 |
2.0.5 | 1,887 | 10/26/2023 |
2.0.4 | 1,755 | 10/12/2023 |
2.0.3 | 7,352 | 8/25/2023 |
2.0.2 | 2,242 | 8/16/2023 |
2.0.1 | 4,844 | 6/13/2023 |
2.0.0 | 343 | 6/9/2023 |
1.5.2 | 3,082 | 6/1/2023 |
1.5.1 | 1,742 | 4/27/2023 |
1.5.0 | 398 | 4/25/2023 |
1.4.1 | 714 | 4/11/2023 |
1.4.0 | 221 | 4/6/2023 |
1.3.5 | 16,624 | 10/13/2022 |
1.3.4 | 311 | 10/5/2022 |
1.3.3 | 10,795 | 8/11/2022 |
1.3.2 | 228 | 8/9/2022 |
1.3.1 | 1,090 | 7/20/2022 |
1.3.0 | 179 | 7/19/2022 |
1.2.1 | 3,706 | 7/7/2022 |
1.2.0 | 182 | 7/7/2022 |
1.1.1 | 903 | 6/27/2022 |
1.1.0 | 401 | 6/13/2022 |
1.0.0 | 2,708 | 5/13/2022 |
0.6.5 | 866 | 4/27/2022 |
0.6.4 | 812 | 4/13/2022 |
0.6.3 | 2,231 | 3/31/2022 |
0.6.2 | 276 | 3/26/2022 |
0.6.1 | 205 | 3/25/2022 |
0.6.0 | 510 | 2/2/2022 |
0.5.0 | 772 | 1/24/2022 |
0.4.0 | 531 | 1/13/2022 |
0.3.0 | 5,940 | 11/23/2021 |
0.2.0 | 199 | 10/29/2021 |
0.1.2 | 264 | 9/27/2021 |
0.1.1 | 632 | 9/21/2021 |