AksoraAksora
HomeFeaturesPlatformPricingAPI Docs
Sign inDemo

REST API & Webhooks Reference

Integrate Aksora into your CI/CD pipelines, automated test suites, and internal tools. Query and mutate tasks, test cases, bugs, sprints, and meeting notes programmatically.

OpenAPI 3.0 Spec (JSON)Get API Keys
On this page
AuthenticationGranular ScopesRate LimitingTypeScript SDKWebhooks
Overview
  • Authentication
  • Granular Scopes
  • Rate Limiting
  • TypeScript SDK
Modules (CRUD)
  • tasks
  • bugs
  • test cases
  • test plans
  • test sessions
  • test suites
  • meeting notes
  • assignees
  • sprints
  • users
  • deployments
  • work logs
Webhooks
  • Outbound Webhooks
  • HMAC Verification

Authentication

All requests to the Aksora REST API must include your API key in the Authorization header using the Bearer token scheme.

Authorization: Bearer aksora_live_xxxxxxxxxxxxxxxxxxxx

Granular Scopes & Module Isolation

Access Level Scope
  • Read & Write: Allows GET, POST, PATCH, and DELETE.
  • Read-only: Allows GET only. Mutating endpoints return 403 Forbidden.
Module Whitelist

Restrict keys to specific entities (e.g. only bugs and test-cases). Requests to omitted modules return 403.

Rate Limiting

To protect system availability and prevent abuse, all public REST API endpoints enforce a rate limit of 120 requests per minute per IP address.

When an application exceeds this quota, the API responds with HTTP 429 Too Many Requests along with a Retry-After header specifying the number of seconds to back off before retrying.

TypeScript SDK

import { AksoraClient } from "./sdk/aksora-client";

const aksora = new AksoraClient({
  baseUrl: "https://your-domain.com",
  apiKey: process.env.AKSORA_API_KEY!,
});

// List bugs
const { data: bugs } = await aksora.list("bugs", { limit: 20 });

// Create a test case
const { data: newCase } = await aksora.create("test-cases", {
  title: "Validate OAuth Callback with Expired State",
  priority: "High",
  typeCase: "Functional",
  status: "Draft",
});

Core REST Endpoints

12 modular CRUD endpoints with pagination, search, and scope isolation

GET/api/public/v1/tasks

List items with pagination (?page=1&limit=50&search=keyword).

POST/api/public/v1/tasks

Create a new tasks. Requires write scope.

PATCH/api/public/v1/tasks?id=:id

Update specific fields of an existing item by ID.

DELETE/api/public/v1/tasks?id=:id

Soft-delete or permanently remove an item by ID.

Outbound Webhooks

Subscribe to real-time events triggered inside Aksora. Every time an entity is created, updated, or deleted, a cryptographically signed HTTP POST request is dispatched to your registered endpoint.

Verifying Webhook Signatures

Aksora attaches an X-Aksora-Signature header containing the HMAC-SHA256 hex digest of the raw payload computed with your webhook secret.

import { createHmac } from "crypto";

function verifyAksoraWebhook(rawBody: string, signature: string, secret: string): boolean {
  const expected = createHmac("sha256", secret).update(rawBody).digest("hex");
  return expected === signature;
}
AksoraAksora

Effortlessly manage test plans, live runs, defects, and sprint velocity in one high-velocity QA & engineering platform.

GitHub•Twitter•LinkedIn

Navigate

HomeFeaturesPlatformPricingInteractive Demo

Platform

Test Case ManagementExecution RunsDefect TrackingSprint LifecycleDaily Work Logs

Resources

API DocumentationOpenAPI 3.0 SpecSecurity ArchitecturePrivacy PolicyAbout Aksora

Contact Us

Email: contact@akusaraproject.my.id

Company: Akusara Digital

Global Cloud & On-Premise Support

Help Center
© 2026 Aksora by Akusara Digital. All rights reserved.
Privacy PolicyTerms & SecurityAPI Reference