All documentation

Developer reference

API surfaces, plugin interfaces, and event taxonomy.

Reference material for anyone integrating with Nosdesk. The HTTP API. The PluginAPI surface that plugins call. The SSE event taxonomy fired on the topic bus. The postMessage RPC contract for the sandbox model that's in design.

Planned topics

Each of these will become a written page. If one of them is blocking you, let us know and we'll prioritise it.

  • HTTP API reference

    Coming soon

    Every endpoint registered in backend/src/main.rs with request and response shapes.

  • PluginAPI interface

    Coming soon

    The TypeScript surface plugins call to interact with the host frame.

  • SSE event taxonomy

    Coming soon

    Every event type fired on the topic bus, payload shape, and topic routing.

  • RemoteHostApi (sandbox)

    Coming soon

    The postMessage RPC contract for the upcoming community-tier iframe sandbox. Designed in docs/plugin-sandbox-plan.md.

  • Webhook payloads

    Coming soon

    Event types, payload shape, retry policy, signature verification.

Need this sooner?

We're writing docs in the order people ask for them. Tell us what you're working on and we'll move it up the list.

Get in touch All sections