PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

Authentication

API keys, headers, prefixes, and scopes.

Create keys in the workspace Developer → API Keys page. The secret is shown once.

Headers

Send the secret as either:

x-api-key: wbk_...

or

Authorization: Bearer wbk_...

Keys use the wbk_ prefix. Only the hash is stored. If you lose a secret, revoke the key and create another.

Scopes

Scopes are an append-only bitfield. ALL_ACCESS grants every current and future bit.

ScopeGrants
ALL_ACCESSEvery capability
PROJECTS_READ / PROJECTS_WRITEProjects
TASKS_READ / TASKS_WRITETasks
CUSTOMERS_READ / CUSTOMERS_WRITECustomers
CONTACTS_READ / CONTACTS_WRITEContacts
FORMS_READ / FORMS_WRITECRM intake forms
PIPELINES_READ / PIPELINES_WRITEPipelines and deals
INVOICES_READ / INVOICES_WRITEInvoices
PAYMENTS_READ / PAYMENTS_WRITEPayments
EXPENSES_READ / EXPENSES_WRITECompany expenses, categories, and budgets
CATALOG_READ / CATALOG_WRITEProducts and plans (Commerce catalog)
COMMUNICATIONS_READ / COMMUNICATIONS_WRITEChannels and messages
EMBED_WRITEMint embed sessions and list that user's projects

Narrower scopes cover single features. They exist mainly for community apps, and a key can hold them too:

ScopeGrantsAlso satisfied by
EVENTS_READList and read eventsCONTACTS_READ, CONTACTS_WRITE
EVENT_REGISTRATIONS_WRITERegister, cancel and set attendanceCONTACTS_WRITE
FORMS_SUBMITSubmit a form as a community memberFORMS_WRITE
COMMUNITY_MESSAGES_READCommunity channels and message history—
COURSES_READCourse outlines and member progressCOURSE_PROGRESS_WRITE
COURSE_PROGRESS_WRITEComplete or uncomplete a module for a member—

WRITE implies the matching READ check in the handler. A key with only FORMS_SUBMIT lists only published forms shown in community apps.

EMBED_WRITE is required for embedded projects. Mint sessions from your server — never from the browser.

Rate limits

Authenticated requests are limited to about 60 per minute per key. Exceeding that returns 429.

The same key authenticates MCP at POST /api/mcp/{workspaceId} for Claude, ChatGPT, editors, and any Streamable HTTP client. The key must belong to that workspace.

REST API

Authenticate, paginate, and handle errors on the Planeward public API.

Webhooks

Outbound signed deliveries, event catalog, and URL rules.

On this page

HeadersScopesRate limits