HyoNovaDocumentation

For developers

The reading path for developers — how HyoNova is built, the conventions its API follows, the Hyo Mail API available today, and the public API and MCP that are planned.

GuideFor: Developers, IT & securityLast updated:
On this page

This guide is for developers and IT teams who want to understand how HyoNova works or plan an integration. Start with the most important fact: the only public API today is the Hyo Mail API — transactional email with API keys, a message log and signed webhooks. HyoNova has no public API for people, work or customer data, and no MCP server. The web app talks to HyoNova's own platform API, which is not offered for integrations.

What you can do today is send transactional email through the Mail API, understand the architecture and security model, and prepare for the next public APIs.

What you'll do#

  • Understand how the product, the office and the company data fit together.
  • Review how sign-in, sessions and tenant isolation work — for example, for a security review.
  • Learn the conventions HyoNova's APIs follow, so your future integration fits them.
  • Follow the general public API and MCP as they arrive.

Your path#

  1. Developers — what exists today and what doesn't.
  2. Architecture — the parts of HyoNova and how they connect.
  3. Authentication — sessions and how access is checked.
  4. Security — encryption, isolation between companies and what HyoNova does not claim.
  5. API conventions — errors, pagination, idempotency and rate limits.
  6. Mail API and Webhooks — send transactional email and receive the signed webhooks Hyo Mail sends to your systems.
  7. MCP — the planned connection for AI assistants.
  8. Integrations — the services HyoNova provides today and what customers cannot connect yet.

What's coming for developers#

Until then, please don't build against the web app's internal API: it can change without notice.

Developers

What developers can build with HyoNova today — the Hyo Mail API with API keys, signed webhooks and a store plugin — and what is planned next.

Architecture overview

A simplified view of how HyoNova fits together — the web app, the HyoNova platform, the media and email services, and company-isolated data.

API conventions

The conventions HyoNova APIs follow — base URL, JSON errors, request IDs, HTTP status codes, cursor pagination, idempotency keys and rate limits — as the Mail API applies them.

Webhooks

Receive signed Hyo Mail events at your HTTPS endpoint — delivery, engagement, contact, conversion and store events — verify the signature, and handle retries.

↑↓ to navigate · Enter to open · Esc to close