GUIDES

Guides and examples.

Longer walkthroughs for common integration tasks. Use them alongside the API reference and endpoint-level examples.

API reference Playground
COVERAGE NOTES
Billing and webhook examples
This section is being expanded with more billing, accounting, and webhook walkthroughs, including examples that connect Alga events to external systems.
Read a billing guide
Quickstart6 minBeginner

Set up API keys in Alga PSA

Create a personal API key in Alga PSA, store it safely, and test it with X-API-Key.

Open guide
Quickstart5 minBeginner

Make your first API call

Create a key, call a simple read endpoint, and understand the basic response shape.

Open guide
Ticketing12 minIntermediate

Create a ticket with the REST API

Look up boards, statuses, priorities, and clients, then create a ticket with a valid payload.

Open guide
Ticketing10 minIntermediate

Add comments and files to a ticket

Read ticket comments, add new comments, and upload files with multipart form data.

Open guide
Billing10 minIntermediate

List and retrieve invoices

Use pagination, filters, and include flags to inspect invoice records and invoice details.

Open guide
Billing18 minAdvanced

Preview, generate, finalize, and send recurring invoices

Walk through the recurring invoice flow using the preview, generate, finalize, and send endpoints.

Open guide
Webhooks12 minIntermediate

Create and manage webhooks

Create webhook configurations, choose event types, and inspect delivery analytics.

Open guide
Webhooks10 minIntermediate

Verify, test, and retry webhooks

Use the verification and testing endpoints, then inspect and retry delivery records.

Open guide
Projects14 minIntermediate

Work with projects, phases, and tasks

Create projects, add phases, fetch task status mappings, and create tasks with the required IDs.

Open guide
TypeScript14 minIntermediate

Call ticket APIs from TypeScript

Build a small TypeScript wrapper around fetch for listing, creating, and updating tickets.

Open guide