HyoNovaDocumentation

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.

AvailableWorks today for workspaces whose plan includes it.ConceptFor: Developers, IT & security, EvaluatorsLast updated: Introduced:
On this page

This section is for developers and IT teams who want to connect HyoNova to other systems. It starts with what exists today, because that decides what you can build.

What you can build today#

HyoNova's public API is the Hyo Mail API at https://api.hyonova.com. With it, your own product can:

  • Send transactional email — receipts, confirmations and account notices — through Hyo Mail, one message per call, from your templates or your own HTML.
  • Read the message log and each message's delivery events.
  • Create and update contacts with their consent, and record orders for campaign attribution.
  • Receive signed webhooks when messages are sent, delivered, bounced, opened or clicked, when someone unsubscribes or complains, and when contacts or store orders change.

It authenticates with API keys that a Mail administrator creates in Mail › Automations › API keys. Every plan includes the API. Each message uses one Mail credit, and sending needs a verified sender on your own domain.

To connect a WordPress site, a WooCommerce store or a Shopify store without writing code, see Connect your store.

Mail API

Send transactional email and manage contacts from your own systems with the Hyo Mail API — API keys, endpoints, examples, idempotency, errors and limits.

Webhooks

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

Connect your store

Connect WordPress, WooCommerce or Shopify to Hyo Mail — sign-up forms with double opt-in, and customer, order and product sync — and what each connection needs.

What is not public#

Everything else in HyoNova — people, work, customers, meetings, office worlds — is used through the web app at https://app.hyonova.com. There is no public API for it yet.

What else you can rely on today:

  • Stable product addresses. Your company address and office addresses keep working, and old addresses redirect after a change. See Company settings.
  • Links you create in the product. Invitation links, guest links and Mail sign-up forms can be shared through your own tools and website.
  • Documented conventions. API conventions describes the errors, pagination, idempotency and rate limits that HyoNova APIs follow.

What is coming#

CapabilityStatusWhat it will do
SMTP relay for Hyo MailPlannedSend through Hyo Mail over SMTP from systems that cannot call an HTTP API
Public HyoNova APIPlannedA supported, documented API for your company's people, work and customer data
MCP serverPlannedLet AI assistants work with your HyoNova data through the Model Context Protocol, with your permission
FeatureStatusNotes
Transactional email APIAvailableWorks today for workspaces whose plan includes it.Send email from your own systems with API keys, a message log and signed webhooks. Part of Hyo Mail.
Signed webhooksAvailableWorks today for workspaces whose plan includes it.Receive signed Hyo Mail delivery, engagement, contact and store events at your HTTPS endpoint, with automatic and manual retries.
SMTP relay for Hyo MailPlannedOn the HyoNova roadmap. Not built yet and has no release date.Send through Hyo Mail over SMTP.
Public HyoNova APIPlannedOn the HyoNova roadmap. Not built yet and has no release date.A supported, documented API for your company’s people, work and customer data.
MCP serverPlannedOn the HyoNova roadmap. Not built yet and has no release date.Let AI assistants work with your HyoNova data through the Model Context Protocol, with your permission.

Start here#

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.

Authentication

How people, guests and systems authenticate to HyoNova — browser sessions with secure cookies and CSRF tokens, guest links, and API keys for the Mail API.

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.

Mail API

Send transactional email and manage contacts from your own systems with the Hyo Mail API — API keys, endpoints, examples, idempotency, errors and limits.

Webhooks

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

MCP server

A HyoNova MCP server is planned, so AI assistants can work with your HyoNova data through the Model Context Protocol, with your permission.

PlannedOn the HyoNova roadmap. Not built yet and has no release date.

Mail API

Send transactional email and manage contacts from your own systems with the Hyo Mail API — API keys, endpoints, examples, idempotency, errors and limits.

Webhooks

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

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.

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.

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