API reference for integrations

Contract scope

The machine-readable contract covers the configured API host: discovery, liveness, database-backed readiness, public-safe provider and queue health, Meta verification, encrypted Flow data exchange, and signed WhatsApp, payment, logistics, and payout callbacks.

Neo does not expose buyer, seller, creator, or operator data as a public CRUD API. Those journeys run through WhatsApp or protected server-rendered pages. Callback presence also does not mean that a provider capability is enabled or certified.

Open the OpenAPI JSON

Interactive schema explorer

Expand an operation to inspect its parameters, authentication boundary, request schema, response schema, and failure modes. Request execution and credential entry are disabled in this public explorer.

Authentication and delivery safety

Provider callbacks authenticate the exact raw request with adapter-specific HMAC headers or callback tokens. Neo validates the selected adapter, durably stores a normalized inbox event, reports duplicates explicitly, and processes work asynchronously. Never paste a real verification token, signature, credential, or raw customer payload into this public page.

Read-only health endpoints require no credential. Their responses intentionally exclude secrets, private certification evidence, queue payloads, and customer data.

Source of truth and maintenance

src/openapi.ts owns the generated contract. src/dev-server.ts remains the runtime source of truth for route behavior, while provider adapters own signature and payload parsing. Contract validation checks path and operation inventory, stable operation IDs, callback security, schemas, branding, and public disclosure safety.

When an HTTP route, header, callback payload, response, rate limit, provider boundary, or capability status changes, update the runtime, OpenAPI contract, focused tests, this page, and the traceability ledger together.

• src/openapi.ts
• src/dev-server.ts
• src/provider-runtime.ts
• test/openapi.test.ts
• test/web.test.ts