TeamBoost Integrations API#
TeamBoost Integrations is the service that connects TeamBoost to external task managers, communication tools, code hosts, and calendars. It is organized by capability, not by provider: the connection flows (CSV import, API-key sync, webhooks, app installs) are written once and parameterized by provider, so each new provider only contributes its own adapter.
This documents what exists today
These docs describe only the endpoints and behavior that are actually implemented and reachable right now. Designed-but-unbuilt capabilities live on the Roadmap, clearly marked as not yet available.
What's built today#
The service boots as a FastAPI app with the core request edge in place: authentication, API versioning, a typed error envelope, provider discovery, and health probes. No provider adapters are registered yet, so the provider list is currently empty — adapters arrive as each provider ships (see the Roadmap).
| Endpoint | Method | What it does |
|---|---|---|
/health |
GET | Liveness — the process is up. Unauthenticated. |
/health/ready |
GET | Readiness — Mongo and Redis are reachable (503 service_unavailable if not). Unauthenticated. |
/api/v1/providers |
GET | Lists registered providers. Currently []. |
/api/v1/providers/{provider} |
GET | Returns a provider's declared capabilities, or 404 unknown_provider. |
Routes under /api/v1 require a Bearer API key and accept an optional API
version header — see Authentication. The /health probes
sit outside /api/v1 and need neither.
How responses are shaped#
Every successful response is wrapped in a stable envelope:
{ "status": "success", "data": { "providers": [] } }
Errors use a matching envelope with a stable, machine-readable error code — see
Errors for the full list and how to handle them.
Where to go next#
- Authentication — Bearer key and the
X-Api-Versionheader. - Providers — the discovery endpoints and the capability model.
- Errors — the error envelope and current error codes.
- Roadmap — integration methods and providers that are designed but not yet built.