HookSniff 1.2.2

HookSniff C# SDK

<p align="center"> <a href="https://www.nuget.org/packages/HookSniff"><img src="https://img.shields.io/nuget/v/HookSniff" alt="NuGet"></a> <a href="https://github.com/servetarslan02/hooksniff-csharp"><img src="https://img.shields.io/github/license/servetarslan02/hooksniff-csharp" alt="License"></a> <a href="https://hooksniff.vercel.app"><img src="https://img.shields.io/badge/webhook-platform-blue" alt="HookSniff"></a> </p>

Official C# SDK for HookSniff — reliable webhook delivery for developers.

Installation

dotnet add package HookSniff

Package Reference

<PackageReference Include="HookSniff" Version="1.2.0" />

Quick Start

using HookSniff;

// Initialize client
var client = new HookSniffClient(
    "hs_xxx_your_api_key",
    new HookSniffOptions("https://hooksniff-api-1046140057667.europe-west1.run.app")
);

// List endpoints
var endpoints = await client.Endpoint.ListAsync("app_xxx");
Console.WriteLine($"Endpoints: {endpoints.Count}");

// Create an endpoint
var newEndpoint = await client.Endpoint.CreateAsync("app_xxx", new EndpointIn
{
    Url = "https://your-app.com/webhook"
});
Console.WriteLine($"Created: {newEndpoint.Id}");

// Send a webhook message
var message = await client.Message.CreateAsync("app_xxx", new MessageIn
{
    EventType = "order.created",
    Payload = new Dictionary<string, object>
    {
        { "order_id", "12345" },
        { "total", 99.99 }
    }
});
Console.WriteLine($"Message sent: {message.Id}");

Authentication

Use your API key (starts with hs_) or a JWT token from the login endpoint.

// With API key
var client = new HookSniffClient("hs_xxx");

// With custom base URL
var client = new HookSniffClient(
    "hs_xxx",
    new HookSniffOptions("https://hooksniff-api-1046140057667.europe-west1.run.app")
);

// With custom retry schedule (max 5 retries)
var client = new HookSniffClient(
    "hs_xxx",
    new HookSniffOptions(retryScheduleMilliseconds: new List<int> { 50, 100, 200, 500, 1000 })
);

Webhook Verification

Verify incoming webhook signatures using HMAC-SHA256 (Standard Webhooks compliant).

using HookSniff;
using HookSniff.Exceptions;

var webhook = new Webhook("whsec_your_signing_secret");

try
{
    // With a Func<string?, string?> headers provider
    webhook.Verify(payload, headerName => request.Headers[headerName]);
    Console.WriteLine("✅ Signature valid!");
}
catch (WebhookVerificationException ex)
{
    Console.WriteLine($"❌ Invalid signature: {ex.Message}");
}

HookSniff Branded Headers

The SDK supports both branded and unbranded headers:

// HookSniff branded
webhook.Verify(payload, key => headers.TryGetValue(key ?? "", out var val) ? val : null);
// Looks for: hooksniff-id, hooksniff-timestamp, hooksniff-signature

// Standard Webhooks (unbranded)
// Looks for: webhook-id, webhook-timestamp, webhook-signature

Signing Webhooks

var signature = webhook.Sign(
    msgId: "msg_xxx",
    timestamp: DateTimeOffset.UtcNow,
    payload: jsonString
);
// Returns: "v1,<base64-signature>"

Resources

Core

Faz 8-15 — New Features

Additional Resources

Error Handling

The SDK throws ApiException for HTTP errors with status code and response body:

using HookSniff;

try
{
    var endpoint = await client.Endpoint.GetAsync("app_xxx", "ep_xxx");
}
catch (ApiException ex)
{
    Console.WriteLine($"Status: {ex.ErrorCode}");     // e.g., 404
    Console.WriteLine($"Body: {ex.ErrorContent}");     // JSON error response
    Console.WriteLine($"Message: {ex.Message}");       // Error description
}

Common Status Codes

Rate Limiting

The SDK automatically handles 429 rate limit responses:

• Reads the Retry-After header
• Waits the specified duration
• Retries the request automatically

For 5xx server errors, the SDK retries with exponential backoff using the configured retry schedule.

Requirements

• .NET 8.0+
• Newtonsoft.Json 13.0+

Links

• 📖 Documentation
• 🔑 API Reference
• 💰 Pricing
• 🐛 Report a Bug
• 💬 GitHub Discussions

License

MIT — see LICENSE for details.