PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

Developer hub

Create an API key, register a webhook, or connect MCP.

Settings → API Keys and Settings → Webhooks hold credentials and outbound endpoints. Workflows stay in the sidebar. Open MCP from ⌘K (or go to /mcp if you already have the URL). Settings → Embed configures the iframe.

Headers, signing, and the tool catalog are in the technical pages: Authentication, Webhooks, MCP, Embedded projects.

API keys

Settings → API Keys, then Create key. Give it a name and either full access or the scopes you need. Create.

Copy the secret immediately — it is shown once. Then click I saved this.

Open a key to see Usage (each request) or Settings (rename or Revoke key). You cannot change scopes later.

Webhooks

Settings → Webhooks, then add an endpoint. HTTPS only, reachable from the internet. Subscribe to everything or pick events. Copy the signing secret once.

Send test event queues a sample. Deliveries is the log. Pause or delete the endpoint in Settings. How to verify signatures: Webhooks.

MCP

Press ⌘K and choose MCP, or open the MCP page directly. Copy the Endpoint. Claude.ai, Claude Desktop, and ChatGPT only need that URL — they sign in with OAuth. Editors and Claude Code send an API key on each request.

When a hosted client asks for access, you confirm scopes for that workspace, then Allow or Deny. Full client setup: MCP.

The same page also lists Outbound connections — remote Streamable HTTP servers an AI Agent MCP tool can call. Header, bearer, and API key use a workflow secret. OAuth is stored on the connection so tokens can refresh.

Embed

Settings → Embed. Turn the iframe on, allow-list host origins, and set branding. Your backend mints a session with EMBED_WRITE, then drops the returned URL in an iframe. Full flow: Embedded projects.

Community apps

Build apps that run inside a community as a member channel or a staff dashboard. Create them in Settings › Apps › Developer. Start with Community apps and the Quickstart.

Next

  • Workflows and expressions
  • REST API
  • API reference

Task description content

Stored Plate JSON contract — canonical field, allowed nodes, security, and write rules.

Community apps

Build apps that run inside a Planeward community as an iframe.

On this page

API keysWebhooksMCPEmbedCommunity appsNext