Skip to content

README.md

Latest commit

 

History

History
57 lines (39 loc) · 3.26 KB

README.md

File metadata and controls

57 lines (39 loc) · 3.26 KB
Raw

Midfleet examples

Tests MIT License Documentation Ask the community

A real Midfleet Workflow API example moving from preflight to verified evidence

Tested, server-side building blocks for taking AI-agent work from intent to evidence-backed completion—without publishing the private Midfleet product repository.

Prove the integration locally in five minutes

You need Node.js 20 or later. The quickstart uses local fakes, requires no Midfleet account or credentials, and makes no network calls to Midfleet Cloud.

git clone https://github.com/Midfleet/examples.git
cd examples
npm ci
npm run quickstart

Expected result:

# tests 7
# pass 7
# fail 0

That verifies the public Workflow API client, signed-delivery verifier, and GitHub Actions evidence builder together.

Choose your path

Example Build this What it demonstrates
workflow-api-typescript A server-side governed workflow integration resolve → preflight → invoke → launch → consume, typed blockers, idempotency, and scoped authentication
signed-delivery-webhook A secure workflow-delivery endpoint Exact-body HMAC verification, timestamp windows, constant-time comparison, and delivery IDs
github-actions-evidence Provenance-bearing CI evidence A schema-ready artifact built from GitHub Actions context after required checks pass

Take one example live

  1. Read the Workflow API quickstart.
  2. Copy .env.example to an untracked local file.
  3. Add only the server-side credentials and project identifiers required by the example.
  4. Resolve and preflight before invoking; launch only when the response says the route can launch.
  5. Consume a verified artifact or signed delivery before treating the workflow as complete.

Start with Govern one GitHub issue for the end-to-end product path, or use the Workflow API reference for exact request and response behavior.

Public boundary

This repository contains small integration surfaces and tests, not the Midfleet application, infrastructure, private API routes, internal hosts, customer data, or product history. Never expose API keys or signing secrets to browser code, source control, logs, or workflow artifacts.

Found this useful? Star the repository so other developers can find it, then share what you built in Show and tell.

See CONTRIBUTING.md before proposing a change and SECURITY.md for private vulnerability reporting.