SecureWebhooks.SystemTextJson 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package SecureWebhooks.SystemTextJson --version 1.0.1
                    


                    

                
NuGet\Install-Package SecureWebhooks.SystemTextJson -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SecureWebhooks.SystemTextJson" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SecureWebhooks.SystemTextJson" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SecureWebhooks.SystemTextJson" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SecureWebhooks.SystemTextJson --version 1.0.1
                    


                    

                
#r "nuget: SecureWebhooks.SystemTextJson, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package SecureWebhooks.SystemTextJson@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=SecureWebhooks.SystemTextJson&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SecureWebhooks.SystemTextJson&version=1.0.1
                    


                            Install as a Cake Tool

SecureWebhooks

SecureWebhooks is a .NET library that implements GitHub-style webhook security, enabling you to securely send and validate webhook payloads using HMAC signatures. This approach follows the best practices outlined in GitHub's official documentation.

Features

  • HMAC Signature Generation & Validation: Easily create and verify signatures for webhook payloads.
  • Flexible Integration: Works with both Newtonsoft.Json and System.Text.Json serializers.
  • Reusable Helpers: Simple APIs for both sending and receiving secure webhooks.

Getting Started

Sending a Secure Webhook

Use the WebhookHelpers.CreateContentWithSecureHeader method to generate an HTTP request body and the appropriate signature header:

var (content, signatureHeader) = WebhookHelpers.CreateContentWithSecureHeader(payload, secret);
// Add 'content' as the request body and 'signatureHeader' as the header in your HTTP request

Validating a Webhook Request

On the receiving side, use WebhookHelpers.ValidateAndGetPayload to validate the signature and extract the payload:

var (isValid, payload) = WebhookHelpers.ValidateAndGetPayload(requestBody, signatureHeader, secret);
if (!isValid)
{
	// Handle invalid signature
}
// Use 'payload' as your deserialized object

Packages

  • SecureWebhooks (core logic)
  • SecureWebhooks.Newtonsoft (for Newtonsoft.Json)
  • SecureWebhooks.SystemTextJson (for System.Text.Json)

License

This project is licensed under the MIT License.

For more details, see the source code and examples in the repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 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 is compatible.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 569 12/1/2025
1.0.0 565 12/1/2025
1.0.0-preview-02 199 1/29/2024
1.0.0-preview-01 128 1/26/2024