Integrators · Quickstart

Build with FluxDesk

One page to choose your integration mode, then jump to the right spec. Push events in, receive webhooks out, drive an AI agent through MCP, or orchestrate access via the catalog.

I want to push data INTO FluxDesk

Notify employees · monitoring alerts · system integration events

You need: Inbound API + Bearer token

Mode 1 — Personal direct (recommended)
Employee self-claims their own token, drops it into a simple script or a monitoring SaaS. Tightest blast radius; one owner per token.
Mode 2 — Admin moderation
Third-party / external systems. Events land in the admin moderation queue first; admin forwards to the right employee. Use when the upstream content shape is unpredictable.
Mode 3 — Tools-claim (admin orchestrator)
Admin issues a single tools-token, your CLI claims per-employee personal tokens on demand. Used by fd1 + internal CLIs that need to fan out to many employees.

Full guide →

I want to RECEIVE FluxDesk events

Read receipts · request approvals · status changes · onboarding completions

You need: Outbound webhook + HMAC-SHA256 verification

Per-employee
Configure at /me/agent. Receives that user's events only.
Tenant-wide
Not yet shipped. For now, configure per-employee webhooks at /me/agent (each admin/HR can subscribe their own); tenant-wide /admin/integrations is on the roadmap.

Full guide →

I want an AI agent to READ / WRITE FluxDesk

Claude Code · Claude Desktop · Cursor · any MCP-compatible runtime

You need: MCP Streamable HTTP + sk-flux-… bearer

38+ tools
Cover tasks, feedback, projects, daily updates, inbound events, outbound webhooks. List them via the JSON-RPC tools/list method.
Per-user scope
Every tool call writes audit-log rows attributed to the bearer-token's owner. No tenant-wide token; admins issue one per user.

Full guide →

I want to MANAGE catalog approvals

Programmatic team-support: assign / approve / revoke resource grants

You need: /api/v1/catalog/* + admin tools-token + (optional) team_support.approved webhook

Catalog row CRUD
Create / update / archive resource definitions. Same shape as the admin UI in /team-support.
Approval lifecycle
Direct-assign without an employee request, approve a pending one, or revoke an existing grant. All audited.

Full guide →

Recipes — copy from someone with the same shape

End-to-end case studies. Pick the one closest to your setup and skim the code paths it touches.

fd1 · FluxPrimeStudio admin orchestrator →
Mode 3 (tools-claim) + catalog assign + outbound team_support.approved webhook. Auto-provisions OpenAI / Anthropic / SSH access for new hires.
More recipes coming. Have a setup worth documenting? [email protected]

Canonical specs

OpenAPI 3.1: /api/v1/openapi.json
Swagger UI: /api/v1/docs (try-it-now console)
Inbound spec (markdown): /api/internal-os/integrations/protocol
MCP tools list: /docs/integrations/mcp

shell

curl https://my.fluxdesk.net/api/v1/openapi.json