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

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

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

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

License

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