APIAlerts 1.0.0

API Alerts • C# / .NET / Unity / Godot Client

NuGet • GitHub • API Alerts

Effortless project notifications. Send once, deliver everywhere.

Targets netstandard2.0 and net10.0. Works in:

• .NET 10 / .NET 8 (ASP.NET Core, Blazor, Azure Functions, console apps)
• .NET Framework 4.6.1+ and Mono
• Unity (2018+, both Mono and IL2CPP backends)
• Godot C# projects

Installation

.NET

dotnet add package apialerts

Unity

NuGet packages don't import into Unity natively. Two options:

1. NuGetForUnity (recommended) - install the tool, search for apialerts, click install.
2. Direct DLL drop - download the latest .nupkg from NuGet, rename to .zip, extract the netstandard2.0/APIAlerts.dll, and drop it into Assets/Plugins/ in your Unity project.

Godot (C#)

dotnet add package apialerts

Standard .NET tooling works in Godot C# projects.

Quick Start

using APIAlerts;

ApiAlerts.Configure("your-api-key");
await ApiAlerts.SendAsync(new Event { Message = "Deploy complete" });

Usage

Global singleton

Call Configure once at startup, then use Send / SendAsync anywhere.

using APIAlerts;

ApiAlerts.Configure("your-api-key");

// Fire-and-forget. Never throws, drops errors silently unless debug is on.
ApiAlerts.Send(new Event { Message = "Deploy complete" });

// Awaitable. Never throws, check result.Success.
var result = await ApiAlerts.SendAsync(new Event { Message = "Deploy complete" });
if (result.Success)
    Console.WriteLine($"Sent to {result.Workspace} ({result.Channel})");
else
    Console.Error.WriteLine($"Error: {result.Error}");

Dependency injection

Register IApiAlertsClient and inject it:

using Microsoft.Extensions.DependencyInjection;

builder.Services.AddApiAlerts("your-api-key");

public class DeployNotifier(IApiAlertsClient alerts)
{
    public Task Notify() => alerts.SendAsync(new Event { Message = "Deploy complete" });
}

Or construct one directly, no container:

IApiAlertsClient alerts = new ApiAlertsClient("your-api-key");

AddApiAlerts routes SDK logs through the app's ILoggerFactory. Use the instance client for DI, mocking, or multiple keys; the ApiAlerts singleton stays for quick one-off use.

Enable debug logging

ApiAlerts.Configure("your-api-key", debug: true);

The SDK uses Microsoft.Extensions.Logging.ILogger. By default it logs to NullLogger.Instance (silent). Inject your application's logger to surface SDK output:

ApiAlerts.Configure(
    "your-api-key",
    debug: true,
    logger: serviceProvider.GetRequiredService<ILogger<Program>>()
);

Critical errors (missing API key, not configured) always log regardless of the debug flag.

Custom HttpClient

Inject your own HttpClient to share connection pools, plug in handlers (Polly, retry, proxy), or route through IHttpClientFactory:

ApiAlerts.Configure(
    "your-api-key",
    httpClient: httpClientFactory.CreateClient("apialerts")
);

If you don't provide one, the SDK creates an HttpClient with a 30-second timeout.

Event fields

Only Message is required. All other fields are optional and omitted from the JSON payload when null.

var evt = new Event
{
    Message  = "Deploy complete",
    Channel  = "releases",
    EventKey = "ci.deploy.success",
    Title    = "Deployed",
    Tags     = new[] { "CI/CD", "C#" },
    Link     = "https://github.com/apialerts/apialerts-csharp/actions",
    Data     = new { version = "1.0.0" },
};

await ApiAlerts.SendAsync(evt);

Send to multiple workspaces

Pass an apiKey as the optional last argument to override the configured key for a single call.

ApiAlerts.Send(new Event { Message = "Deploy complete" }, apiKey: "other-workspace-api-key");

var result = await ApiAlerts.SendAsync(
    new Event { Message = "Deploy complete" },
    apiKey: "other-workspace-api-key"
);

API

SendResult fields

Game dev use cases

• Unity build pipelines: ping Slack/Discord/your phone when a Unity Cloud Build finishes
• Godot CI: notifications when GitHub Actions builds your .pck or exports finish
• Live ops: server-side alerts when a player triggers a webhook, crash report hooks
• In-editor scripts: long-running asset import notifications

Links

• Documentation
• Sign up
• GitHub Issues
• NuGet Package