Aiursoft.AlertCenter.SDK
10.2.0
See the version list below for details.
dotnet add package Aiursoft.AlertCenter.SDK --version 10.2.0
NuGet\Install-Package Aiursoft.AlertCenter.SDK -Version 10.2.0
<PackageReference Include="Aiursoft.AlertCenter.SDK" Version="10.2.0" />
<PackageVersion Include="Aiursoft.AlertCenter.SDK" Version="10.2.0" />
<PackageReference Include="Aiursoft.AlertCenter.SDK" />
paket add Aiursoft.AlertCenter.SDK --version 10.2.0
#r "nuget: Aiursoft.AlertCenter.SDK, 10.2.0"
#:package Aiursoft.AlertCenter.SDK@10.2.0
#addin nuget:?package=Aiursoft.AlertCenter.SDK&version=10.2.0
#tool nuget:?package=Aiursoft.AlertCenter.SDK&version=10.2.0
AlertCenter
AlertCenter is a self-hosted alert management and notification platform built on ASP.NET Core (.NET 10). Business systems create incidents through one HTTP API; teams manage incidents, on-call schedules, and delivery through Webhook, email, and in-app notifications.
On an empty database, the default local account is admin@default.com with password Admin@123456!. Change the password before exposing the application.
What is AlertCenter?
- Independent API keys, idempotent reporting, and five severity levels (
sev0throughsev4). - Independent incidents, acknowledgement, ownership, mitigation, resolution, and Markdown discussions.
- On-call teams, reusable scheduling rules, and an interactive schedule editor with overlap and rest validation.
- Severity-based notification routing, personal inboxes, and delivery history.
- Application access grants for users and roles, with separate permissions for application, on-call, and push management.
- SQLite for standalone use, MySQL support, and local or OIDC authentication through Aiursoft Template.
Run manually
Install the .NET 10 SDK and Node.js/npm.
Prepare the frontend assets:
npm ci --prefix src/Aiursoft.AlertCenter/wwwroot npm run build --prefix src/Aiursoft.AlertCenter/wwwrootStart the application:
dotnet run --project src/Aiursoft.AlertCenterOpen the URL printed by the application.
The defaults use SQLite and local accounts. Configure authentication, database, and storage through appsettings.json or environment variables.
Run in Microsoft Visual Studio
- Prepare the frontend assets as described above.
- Open
Aiursoft.AlertCenter.slnand run theAiursoft.AlertCenterproject withF5.
Run in Docker
image=aiursoft/alertcenter
appName=alertcenter
sudo docker pull $image
sudo docker run -d --name $appName --restart unless-stopped -p 5000:5000 -v /var/www/$appName:/data $image
Open http://localhost:5000. Keep /data persistent for configuration, the SQLite database, uploaded files, and Data Protection keys.
| Properties | Value |
|---|---|
| Image | aiursoft/alertcenter |
| Ports | 5000 |
| Binary path | /app |
| Data path | /data |
| Config path | /data/appsettings.json |
The image copies its default configuration to /data/appsettings.json on first start and retains that file on subsequent starts. Environment variables use double underscores, such as ConnectionStrings__DefaultConnection or AppSettings__OIDC__ClientSecret.
Creating incidents
Open Applications to create an application and save its API key. The key is shown only on creation or reset; resetting it immediately invalidates the old key. The built-in Integration Guide at /Applications/GettingStarted provides examples for the current server.
Create an incident using POST /api/v1/incidents:
curl -i 'http://localhost:5000/api/v1/incidents' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
--data '{
"reportId": "0c561d22-5b71-4a4f-9c13-c824e273a8aa",
"title": "Order payment timed out",
"content": "The downstream provider did not respond within 5 seconds.",
"level": "sev1",
"occurredAtUtc": "2026-10-16T12:00:00Z",
"context": {"orderId": "ORDER-1001", "traceId": "demo-trace"}
}'
Use your server's HTTPS URL for remote reporting and keep API keys outside source control. Reuse a reportId only when retrying the same report. A new report returns 201 Created; a duplicate returns 202 Accepted with Code: 1 and Duplicate: true. Invalid credentials return 401; invalid fields return 400. Requests are limited to 64 KiB, titles to 200 characters, and content to 4,000 characters.
The API uses AiurProtocol. Receipts contain Code, Message, ProtocolVersion, ReportId, ReceivedAtUtc, IncidentId, and Duplicate. A new report uses Code: 2 (JobDone); a duplicate uses Code: 1 (NoActionTaken). Invalid credentials use Code: -1 (WrongKey); invalid input uses Code: -10 (InvalidInput) with an Items array describing errors. Oversized requests return HTTP 413 with the same invalid-input envelope.
.NET SDK
Install the .NET 10 reporting client:
dotnet add package Aiursoft.AlertCenter.SDK
Register it with your server's base URL and an application key from configuration:
using Aiursoft.AlertCenter.SDK;
using Aiursoft.AlertCenter.SDK.Models;
builder.Services.AddAlertCenterSdk(
"https://alertcenter.example.com",
builder.Configuration["AlertCenter:ApiKey"]!);
Inject AlertCenterApiClient and send a report:
public class PaymentIncidents(AlertCenterApiClient incidents)
{
public Task<CreateIncidentResponse> ReportTimeoutAsync(Guid reportId, DateTimeOffset occurredAtUtc)
=> incidents.CreateIncidentAsync(new CreateIncidentRequest
{
ReportId = reportId,
Title = "Order payment timed out",
Level = "sev1",
OccurredAtUtc = occurredAtUtc
});
}
Generate and retain the report ID and occurrence time before the first attempt. The SDK sends once; after an uncertain network outcome, retry the same request with the same ID. Successful duplicates return the original receipt. Input errors throw AiurBadApiInputException; authentication and other protocol failures throw AiurUnexpectedServerResponseException (inspect its Response.Code). These types are in Aiursoft.AiurProtocol.Exceptions. Transport failures propagate to the caller. The SDK reports persistence and dispatch scheduling, not notification delivery success.
For rotating credentials, register your own scoped IAlertCenterApiKeyProvider; the client retrieves a key for each call. Keep the client on the server, never in a browser.
Reporting clients must rate-limit at the source. Each new report ID creates an independent incident, even when its content matches another incident. Retrying the same application/report ID returns the original receipt without creating another incident or delivery. All handling takes place on the incident detail page.
Query incidents with the SDK
SDK 10.2.0 adds QueryIncidentsAsync (GET /api/v1/incidents). The same application
Bearer key authorizes both reporting and querying; queries only return that application's
incidents, including their complete structured Context.
var page = await client.QueryIncidentsAsync(new QueryIncidentsRequest
{
ActiveOnly = true,
Page = 1,
PageSize = 50
});
foreach (var incident in page.Items)
{
Console.WriteLine($"{incident.IncidentId}: {incident.Title} ({incident.Status})");
}
ActiveOnly defaults to false; true includes new, acked, and mitigated, excluding
resolved. Pages start at 1 (maximum 1,000,000); page sizes range from 1 to 100 and default
to 50. Responses include Page, PageSize, and TotalCount, with newest received incidents
first and incident ID as the tie-breaker. Read all relevant pages before deciding no match
exists. Pagination reflects live data, not a snapshot across requests.
Callers decide which titles, services, or Context fields constitute a duplicate. The SDK and API do not compare metadata, suppress reports, or make query-and-create atomic. Queries have no state or notification side effects. AiurProtocol response codes and error handling match reporting; invalid query parameters return its validation reasons.
Resolve an incident with the SDK
Use ResolveIncidentAsync (POST /api/v1/incidents/{incidentId}/resolve) after the
calling application has confirmed recovery. Supply the Version returned by a fresh query
and a non-blank Reason of at most 4,000 characters:
var result = await client.ResolveIncidentAsync(incident.IncidentId, new ResolveIncidentRequest
{
Version = incident.Version,
Reason = "Audit run 42 confirmed that the endpoint is healthy."
});
The application key can resolve only its own incidents. Any active state can transition
directly to resolved; the existing human workflow is unchanged. Resolution preserves the
owner and records the previous state, application identity and reason in the incident timeline.
No engineer is impersonated, and no acknowledgement or mitigation steps are fabricated.
The first resolution returns JobDone; an already resolved incident returns NoActionTaken
without another timeline entry. A changed active incident returns Conflict: query again and
re-evaluate recovery rather than blindly retrying with a new version. This also prevents an old
request from closing a subsequently reopened incident. Missing and other-application incidents
both return NotFound. SDK protocol exceptions match reporting. No automatic resolution or
recovery detection runs inside AlertCenter; the caller decides when to invoke this method.
Permissions and on-call response
Platform capabilities use Permission claims. Roles collect permissions; the name Administrators does not grant privileges by itself.
CanManageApplicationspermits creating applications, managing their access grants, and managing all applications. Otherwise, per-application user or role grants provide view or manage access.CanManageOnCallpermits managing teams, scheduling rules, and schedules. Saved shifts determine the current on-call engineers (OCEs); a rule preview alone does not provide coverage.CanManagePushpermits managing channels and sensitive delivery configuration. A user's channel binding access and recipient membership are separate; binding a channel also requires application manage access.
The current OCEs, incident owner, and application managers may handle an incident. A view grant alone does not permit incident handling. Default identity initialization runs only when both users and roles are empty; restarting an existing installation does not restore revoked permissions or grant newly introduced permissions.
Applications may bind an on-call team. Each new incident and explicit incident reopen queues built-in email to that team's current OCEs, independently of custom severity routes. Delivery recipients are snapshotted when queued. Missing coverage or invalid recipient configuration produces a visible delivery failure without rejecting the alert. There are no automatic email retries; inspect delivery records before manually retrying an SMTP failure.
Configuration
See the comments in appsettings.json for database, storage, authentication, and logging settings. Keep secrets in protected environment variables.
- OIDC: set
AppSettings__AuthProvider=OIDCand theAppSettings__OIDC__*values. Register the application's HTTPS/signin-oidccallback with your identity provider and assign the required application permissions. - Email: configure
Email__Host,Email__Port,Email__From, and, when required,Email__UserNameandEmail__Password. STARTTLS is enabled by default. Both custom channels and built-in on-call email use these settings. Emails include HTML and plain-text alternatives with a direct incident link. SetEmail__PublicBaseUrlto your public site address (including any path prefix); it defaults tohttps://alertcenter.aiursoft.com. - Webhook: custom encrypted request headers require
Webhook__HeaderProtectionKey, a Base64-encoded 32-byte key generated withopenssl rand -base64 32. Preserve this key: losing or changing it makes saved custom headers unreadable. Without it, default headers and custom JSON body templates remain available.
Database migrations
The single-incident schema migration removes pre-release incidents, reports and their delivery history. Applications, API keys, users, permissions and channel configuration remain. Back up the database before upgrading; restoring the old application requires restoring the matching database backup. The old message endpoint and SDK reporting types have been removed.
The application applies pending migrations at startup. Generate future migrations for both providers using the SQLite guide and MySQL guide.
How to contribute
Report bugs and suggestions through the issue tracker. Create a fork and a feature branch, then submit a merge request for review.
After preparing frontend assets, run the existing checks:
dotnet test tests/Aiursoft.AlertCenter.Tests.csproj
node --test tests/Frontend/*.test.cjs
./lint.sh
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. |
-
net10.0
- Aiursoft.AiurProtocol (>= 10.0.25)
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 |
|---|---|---|
| 10.10.5 | 106 | 11/16/2026 |
| 10.10.4 | 141 | 11/11/2026 |
| 10.10.3 | 93 | 11/11/2026 |
| 10.10.2 | 161 | 11/3/2026 |
| 10.10.1 | 132 | 10/26/2026 |
| 10.10.0 | 116 | 10/25/2026 |
| 10.9.0 | 151 | 10/20/2026 |
| 10.8.0 | 109 | 10/20/2026 |
| 10.7.2 | 107 | 10/20/2026 |
| 10.7.1 | 114 | 10/19/2026 |
| 10.7.0 | 128 | 10/19/2026 |
| 10.6.0 | 104 | 10/19/2026 |
| 10.5.0 | 103 | 10/19/2026 |
| 10.4.1 | 108 | 10/19/2026 |
| 10.4.0 | 108 | 10/19/2026 |
| 10.3.0 | 117 | 10/18/2026 |
| 10.2.0 | 112 | 10/17/2026 |
| 10.1.0 | 108 | 10/17/2026 |
| 10.0.0 | 107 | 10/17/2026 |