README.md

Octokit.Webhooks

Libraries to handle GitHub Webhooks in .NET applications.

Usage

ASP.NET Core

1. dotnet add package Octokit.Webhooks.AspNetCore

2. 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) {
           ...
       }
   }

3. Register your implementation of WebhookEventProcessor:

   builder.Services.AddSingleton<WebhookEventProcessor, MyWebhookEventProcessor>();

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

1. dotnet add package Octokit.Webhooks.AzureFunctions

2. 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) {
           ...
       }
   }

3. Register your implementation of WebhookEventProcessor:

   .ConfigureServices(collection =>
   {
       ...
       collection.AddSingleton<WebhookEventProcessor, MyWebhookEventProcessor>();
       ...
   })

4. Configure the webhook function:

   new HostBuilder()
   ...
   .ConfigureGitHubWebhooks()
   ...
   .Build();

ConfigureGitHubWebhooks() takes one optional parameter:

• secret. The secret you have configured in GitHub, if you have set this up.

The function is available on the /api/github/webhooks endpoint.

Thanks

• octokit/webhooks
• terrajobst/Terrajobst.GitHubEvents
• Dotnet-Boxed/Templates

License

All packages in this repository are licensed under the MIT license.