Nefarius.Kanboard.API 1.0.0-pre002

Nefarius.Kanboard.API

Strongly-typed C# client library for the Kanboard JSON-RPC API and framework-agnostic webhook payload models with token verification.

Features

• Full coverage of the Kanboard JSON-RPC 2.0 REST API surface, grouped into discoverable sub-clients (Tasks, Projects, Comments, Users, etc.)
• Inbound webhook payload models for all 18 Kanboard events with constant-time token verification
• Handles Kanboard's quirky JSON encoding (numbers as strings, booleans as "0"/"1", unix timestamps as strings)
• Targets netstandard2.0 and net10.0 — works with .NET Framework 4.6.2+ and modern .NET
• Designed for IHttpClientFactory / dependency injection; HttpClient is injected externally

Installation

dotnet add package Nefarius.Kanboard.API

Quick Start — REST API Client

using Nefarius.Kanboard.API.Client;

// Application API (token-based, no user session, full access)
var options = KanboardClientOptions.ForApplicationApi(
    endpoint: new Uri("https://my-kanboard.example.com/jsonrpc.php"),
    apiToken: "MY_API_TOKEN");

// Or User API (username + password or personal access token)
// var options = KanboardClientOptions.ForUserApi(
//     endpoint: new Uri("https://my-kanboard.example.com/jsonrpc.php"),
//     username: "admin",
//     password: "secret");

using var httpClient = new HttpClient();
var client = new KanboardClient(httpClient, options);

// Create a task
int taskId = await client.Tasks.CreateAsync(new CreateTaskRequest
{
    Title = "My first task",
    ProjectId = 1
});

// Get a task
KanboardTask task = await client.Tasks.GetAsync(taskId);
Console.WriteLine(task.Title);

// List all active tasks in a project
IReadOnlyList<KanboardTask> tasks = await client.Tasks.GetAllAsync(projectId: 1, statusId: 1);

// Move a task to another column
await client.Tasks.MovePositionAsync(projectId: 1, taskId: taskId, columnId: 3, position: 1, swimlaneId: 0);

Quick Start — Webhook Receiver

Kanboard POSTs JSON to your configured webhook URL with a ?token= query parameter for origin verification.

using Nefarius.Kanboard.API.Webhooks;

// In your HTTP handler / controller / minimal API endpoint:
string receivedToken = httpRequest.Query["token"];
string body = await new StreamReader(httpRequest.Body).ReadToEndAsync();

// 1. Verify the token (constant-time comparison)
if (!WebhookTokenValidator.IsValid(receivedToken, "YOUR_WEBHOOK_SECRET"))
{
    return Results.Unauthorized();
}

// 2. Parse the envelope
WebhookEnvelope envelope = KanboardWebhookParser.Parse(body);

// 3. Dispatch on event name
switch (envelope.EventName)
{
    case KanboardWebhookEvents.TaskCreate:
        var data = KanboardWebhookParser.GetData<TaskEventData>(envelope);
        Console.WriteLine($"New task created: {data.Task.Title}");
        break;

    case KanboardWebhookEvents.CommentCreate:
        var commentData = KanboardWebhookParser.GetData<CommentEventData>(envelope);
        Console.WriteLine($"Comment on task #{commentData.Task.Id}: {commentData.Comment.Content}");
        break;

    case KanboardWebhookEvents.TaskMoveColumn:
        var moveData = KanboardWebhookParser.GetData<TaskEventData>(envelope);
        Console.WriteLine($"Task moved from column {moveData.Changes?.SrcColumnId} to {moveData.Changes?.DstColumnId}");
        break;
}

Supported Webhook Events

API Groups

Documentation

Link to API docs.