Inkwave Help

Developers

What developers can build on with Inkwave, MCP for assistants and agents, outgoing webhooks and reader links and forms, and what isn't offered.

What you can build on

This section is reference for developers, on docs.inkwave.space only. Its pages don't open in the help panel inside the Inkwave app.

Inkwave offers four ways for your own code, or an AI assistant, to work with a publication:

SurfaceWhat it is forStart here
Publisher APIYour own server code reads and changes one publication over REST: subscribers, posts and stats. Served at https://app.inkwave.space/api/v1.Publisher API
MCPAI assistants and agents that read a publication and, if you allow it, change it. Served at https://mcp.inkwave.space.Connect and authenticate, Tools, Scopes
WebhooksYour server hears about events, such as a new subscriber or a sent post, the moment they happen.Events, Signatures and delivery
Reader links and formsYour own pages sign readers up, embed a subscribe form, or link to a poll.Reader endpoints

What isn't offered

The GraphQL API the Inkwave app uses is not public. It accepts only the app's own sign-in, takes no API keys, and can change without notice, so don't build on it. To read or change a publication from code, use the publisher API or MCP. To react to what happens in one, use webhooks.

Plans

Two plan features gate these surfaces:

  • API access (api_access) is needed for the publisher API and for MCP. The plan also sets how many API requests a publication makes a day (api_daily_requests). See Publisher API. Without API access, a new key or a new connection is refused. Existing keys and connections are kept, but every call is refused until the plan includes API access again. They work again after an upgrade, with nothing to re-create. The plan may also limit how many changes assistants make a day (mcp_daily_writes). See Connect and authenticate.
  • Webhooks (webhooks) is needed to send webhooks. Without it, events are dropped, not queued, and you can't create an endpoint, switch one back on or send a test. Endpoints and their settings are kept. The plan may also limit how many endpoints a publication has.

Reader links and forms work on every plan.

Getting credentials

ForWhereWho
MCP by signing inAdd https://mcp.inkwave.space/mcp to your assistant, sign in and approve. Your own connections are listed under your account menu, Connected Assistants.Anyone on the team, capped by their role
A publisher API key (inkw_api_…)Settings, API, Create key. The key is shown once.The owner and admins
An MCP API key (inkw_mcp_…)Settings, MCP, Create Key. The key is shown once.The owner and admins
A webhook signing secretSettings, Webhooks: open an endpoint to see its Endpoint Secret.The owner and admins

Treat an MCP key like a password, and like a subscriber export if it may read email addresses. Give each assistant or machine its own key, so revoking one doesn't cut off the rest.

On this page