PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

MCP

Streamable HTTP MCP for Claude, ChatGPT, editors, and any MCP client.

The Planeward MCP server exposes the same workspace operations as /api/v1. Any client that speaks Streamable HTTP can connect. Workflows can also call other MCP servers — that is outbound, on Developer → MCP and the AI Agent MCP tool.

Hosted connectors (Claude.ai, Claude Desktop, ChatGPT) use OAuth 2.1. They ignore a pasted wbk_ key. Paste the workspace endpoint from Developer → MCP; the client discovers authorization from a 401 and sends the user through Planeward sign-in. Confirm scopes the same way you would for an API key. Add one connector per workspace.

Editors and Claude Code still send a Developer API key on every request. There is no separate MCP secret. You can use OAuth, a key, or both — they are independent credentials.

Endpoint

POST Streamable HTTP (JSON responses, stateless):

https://app.planeward.com/api/mcp/{workspaceId}

GET returns 405. Send Accept: application/json, text/event-stream (the server also accepts JSON-only). API-key clients send the key on every request the same way as Authentication. Hosted OAuth clients send the access token they received after consent:

Authorization: Bearer wbk_YOUR_KEY

or

x-api-key: wbk_YOUR_KEY

or, after hosted OAuth:

Authorization: Bearer <access_token>

Tools advertised to the client follow that credential's scopes. A read-only projects key or grant does not see write or CRM tools.

Claude

Claude.ai and Claude Desktop

Settings → Connectors → Add custom connector. Paste the workspace endpoint (public HTTPS). Claude runs OAuth — it will not use x-api-key or a static Bearer key. Sign in to Planeward when prompted. Add another connector for each workspace.

This is the same authorization server ChatGPT uses.

Claude Code

claude mcp add --transport http planeward https://app.planeward.com/api/mcp/{workspaceId} \  --header "Authorization: Bearer wbk_YOUR_KEY"

Or add this to .mcp.json / ~/.claude.json. Claude Code requires "type": "http":

{  "mcpServers": {    "planeward": {      "type": "http",      "url": "https://app.planeward.com/api/mcp/{workspaceId}",      "headers": {        "Authorization": "Bearer wbk_YOUR_KEY"      }    }  }}

ChatGPT

Plus, Pro, Business, Enterprise, and Edu (Developer mode). Settings → Apps & Connectors → enable Developer mode → Create.

FieldValue
NamePlaneward
Connector URLThe endpoint above (public HTTPS — not localhost)
AuthenticationOAuth (leave token / custom header empty)

ChatGPT discovers the authorization server from the MCP 401 challenge. Do not paste a wbk_ key.

Editors (Cursor, Windsurf, …)

Remote URL plus headers in the editor's mcpServers config (for Cursor: .cursor/mcp.json or user MCP settings):

{  "mcpServers": {    "planeward": {      "url": "https://app.planeward.com/api/mcp/{workspaceId}",      "headers": {        "Authorization": "Bearer wbk_YOUR_KEY"      }    }  }}

Any MCP client

POST JSON-RPC to the endpoint with Content-Type: application/json and one of the auth headers. The server is stateless and returns JSON. It does not open an SSE stream on GET.

Create the key in workspace Developer → API Keys.

Tool catalog

Naming pattern: planeward-{resource}-{action}. Pagination: limit (1–100, default 50) and offset. CRM, Chats, Sites, and Products and plans (Commerce) tools fail if that workspace module is off.

Lookups

ToolPurpose
planeward-project-status-listStatuses for a projectId — use id as statusId
planeward-project-label-listLabels for a projectId — use id as labelId on tasks
planeward-workspace-member-listActive members — membershipId as assigneeMembershipIds or ownerMembershipId
planeward-project-role-listRoles that can be assigned in a projectId — roleId as assigneeRoleIds
planeward-category-listkind=project or kind=channel — use id as categoryId on projects or channels

Projects

ToolPurpose
planeward-project-listList projects; optional search
planeward-project-getGet by projectId
planeward-project-createCreate
planeward-project-updatePatch by projectId
planeward-project-deleteSoft-delete

Tasks

ToolPurpose
planeward-task-listList by projectId; optional search. parentId lists only that task's subtasks
planeward-task-getGet by taskId
planeward-task-createCreate; statusId must belong to the project. assigneeMembershipIds from planeward-workspace-member-list. Optional assigneeRoleIds from planeward-project-role-list. Optional labelId from planeward-project-label-list. Optional parentId creates it as a subtask. Prefer descriptionContent; plain description is converted only when content is omitted.
planeward-task-updatePatch; assigneeMembershipIds replaces current people ([] clears). assigneeRoleIds replaces current roles the same way; omit it to keep them. labelId sets the single task label (null clears). parentId links or moves the task under a parent (null unlinks). Optional expectedVersion (the task's version) rejects the update when the task changed since you read it
planeward-task-deleteDelete
planeward-task-activity-listA task's history by taskId, newest first, with a plain-text summary per event
planeward-task-comment-listComments on a task by taskId, newest first
planeward-task-comment-createPost a markdown comment on a task (body, optional visibility)

planeward-project-role-list takes projectId, plus the usual limit, offset, and search. It returns { data, total }, where each item is { roleId, name, color, rank }, highest rank first, then by name. REST: GET /projects/{projectId}/roles. A role can be assigned when it has Manage any project, or Editor or Project manager access to the project. Everyone who holds an assigned role owns the task. See assigning roles. Task responses include assigneeRoles: [{ roleId, name }]. A role that cannot be assigned fails with One or more assignee roles are invalid.

Task writes follow the same rules as the app. Titles allow up to 500 characters. Moving a task to a Done status sets completedAt and schedules auto-archive, after which the task is no longer returned. A status change places the task at the end of the new column. Rule violations come back as tool errors with a readable message: a status at its blocking WIP limit fails with Status "<name>" is at its task limit (<n>)., and a stale expectedVersion fails with Task was modified by someone else. Refresh and retry. Read the task again and retry. Without expectedVersion the last write wins.

Subtasks are one level deep. The parent must be a top-level task in the same project, and a task that has subtasks cannot become one. Task responses include parentId. REST: parentId on POST /projects/{projectId}/tasks and PATCH /tasks/{taskId}, and GET /projects/{projectId}/tasks?parentId=.

Activity and comments use the tasks scopes: TASKS_READ to list, TASKS_WRITE to comment. Both lists take limit and offset. The MCP tools return { data, total }, and REST returns the usual { data, meta }.

  • Activity items are { id, eventKey, entityType, entityId, actor: { kind, name, userId }, summary, changes, createdAt }. summary is the sentence the task timeline shows, such as moved this task to Done, or null for events the timeline doesn't show (comments, dependencies). changes is the raw patch with ids, not names.
  • Comments are { id, body, visibility, author: { membershipId, name }, createdAt, editedAt, attachments }. Deleted comments are left out.
  • Posting: body is markdown, up to 20,000 characters. Mention a member with @[membershipId] or a role with @role:[roleId] to notify them. visibility is SHARED (default) or INTERNAL. An OAuth connection comments as its user. An API key comments under the key's name, with no member as author.

REST: GET /tasks/{taskId}/activity, GET /tasks/{taskId}/comments and POST /tasks/{taskId}/comments.

Task templates

Templates belong to a project and use the tasks scopes. statusId, labelId, assigneeMembershipIds, and assigneeRoleIds resolve the same way as tasks. When a template is applied, roles that can no longer be assigned are skipped with a warning. Date rules are { "kind": "none" }, { "kind": "today" }, or { "kind": "offset", "days": 1 }. One active template per project can be isDefault.

ToolPurpose
planeward-task-template-listList by projectId; optional search and includeArchived
planeward-task-template-getGet by projectId and templateId
planeward-task-template-createCreate. Set isDefault to prefill new tasks
planeward-task-template-updatePatch fields, isDefault, or archived
planeward-task-template-deleteDelete

Forms

ToolPurpose
planeward-form-listList intake forms; optional search
planeward-form-getGet by formId
planeward-form-createCreate
planeward-form-updatePatch by formId
planeward-form-deleteDelete
planeward-form-submission-listList submissions; optional formId, source (HOST, SITE, EMBED), or search
planeward-form-submission-getGet by submissionId
planeward-form-submission-updatePatch answers (fields), status (NEW | SPAM), or link ids (null unlinks)
planeward-form-submission-deleteDelete. Answers go; the contact and opportunity stay
planeward-form-generatePrompt → validated definition. Set create=true to save. Uses the Sites AI allowlist

A submission's metadata.utm is its first touch: the visitor's earliest tagged pageview on the site, or the form URL's UTMs when there is none. metadata.pageUtm holds the submit page's UTMs when it had any. Older submissions keep the submit page's UTMs in metadata.utm. See Forms.

Sites

Requires SITES_READ; write tools need SITES_WRITE. Sites tools fail when the Sites app or plan feature is off. Resolve siteId with planeward-site-list and pageId with planeward-site-page-list. Product docs: Sites.

ToolPurpose
planeward-site-listList sites; optional search
planeward-site-getA site with its regular pages, live URL, domains, chrome (headerPageId, footerPageId; null until created), and collections with item counts by status
planeward-site-createCreate a site with an empty homepage
planeward-site-updatePatch name, slug, language, or theme: light colors (seven tokens), optional dark palette, defaultMode (light, dark, system), fonts, icon, searchEngines. Pass the full theme you want stored
planeward-site-deleteMove a site to trash for 30 days
planeward-site-publishPublish draft pages, header, footer, collections and templates, plus Published items with staged changes
planeward-site-unpublishTake the site offline
planeward-site-previewSigned one-hour draft URL for a page
planeward-site-page-listPages with kind, hideHeader, and hideFooter. Returns PAGE unless kind is set (HEADER, FOOTER, TEMPLATE)
planeward-site-page-getA page with kind, hideHeader, hideFooter, contentVersion, and its body tree
planeward-site-page-body-schemaJSON Schema, per-block notes, and an example body. Call before writing a body
planeward-site-page-createCreate a regular page. hideHeader / hideFooter hide the site header or footer on it
planeward-site-page-updatePatch title, slug, hidden, hideHeader, hideFooter, seo, or the full body. Pass expectedContentVersion. Header, footer, and template pages take title and body only
planeward-site-page-reorderSet the order of regular pages; pass every one
planeward-site-set-homepageMake a regular page the homepage
planeward-site-page-deleteDelete a page (not the homepage)
planeward-site-chrome-getHeader and footer drafts: id, body, contentVersion (null if never created)
planeward-site-chrome-updateReplace the header or footer body (part). Creates it on first write. Live on the next publish
planeward-site-domain-listWorkspace domains and their status. purpose is COMMUNITY, CHECKOUT or ACCOUNT for an address that serves the community, checkout or the buyer's account, and null for a site or unattached domain. Checkout and account addresses are added in the app (Settings → Apps → Commerce → Domains)
planeward-site-domain-createRegister a hostname; returns DNS records to add yourself. Optional siteId attaches it
planeward-site-domain-checkRecheck status after the DNS records exist
planeward-site-domain-attach / -detachAttach a workspace domain to a site, or detach it (it stays in the workspace). Attaching a community, checkout or account address takes it away from that role, and needs that app's manage permission on top of SITES_WRITE
planeward-site-domain-set-primaryMake an active domain the site address. Other hosts 308 to it
planeward-site-tracking-getMeta pixel, conversion event, GTM, Clarity, CAPI token presence, test event code, linkedOrigins, and externalOrigins
planeward-site-tracking-updatePatch tracking. linkedOrigins replaces the list of https origins (≤10; [] clears; omit to keep) whose links get pw_site / pw_vid. Live on the next publish. See Linked domains. externalOrigins replaces the sites hosted elsewhere that load /pw.js (≤10; [] clears; omit to keep); live right away. See External sites
planeward-site-crawl-getRobots rules, contentSignal (search, aiInput, aiTrain), wellKnown files, site jsonLd, markdownForAgents, agentLinks
planeward-site-crawl-updatePatch those settings: each top-level key you send replaces the stored value. Applies live without publishing
planeward-site-campaign-listTracking links (campaigns), newest first: id, name, channel, destinationPageId (null = homepage), UTM values, and url (the landing page tagged with them)
planeward-site-campaign-createCreate a tracking link from name and channel, with optional destinationPageId, content, term, source, medium, sourcePlatform, creativeFormat, and marketingTactic. UTMs are generated from channel and name; content tells links on the same channel apart. Returns the link with its numeric id (sent as utm_id) and tagged url. Live at once
planeward-site-campaign-deleteDelete a tracking link by campaignId. Redirects that used it keep working without its tags
planeward-site-redirect-listRedirects, most hits first: path, url (the short link), destination (pageId, title, path; pageId: null = homepage) or destinationUrl, campaign (id, name, utmSource, utmContent, or null), permanent, and all-time hits. See Redirects
planeward-site-redirect-createCreate a redirect from path to destinationPageId or destinationUrl (neither = homepage, never both), with optional campaignId and permanent (308; default 307). Live without publishing
planeward-site-redirect-updatePatch a redirect by redirectId: send only what changes; omitted fields keep their stored value. Sending destinationPageId or destinationUrl switches the destination (both null sends visitors to the homepage); campaignId: null removes the tags
planeward-site-redirect-deleteDelete a redirect. Its path stops redirecting at once and its hit count is lost
planeward-funnel-list / -getFunnels and their steps
planeward-funnel-create / -update / -set-steps / -deleteManage funnels. requiresSubmission on a step locks it until an earlier form is submitted
planeward-storage-list / -uploadLibrary files. Use src (/media/{id}) for images, darkSrc, and ogImage

Page kind is PAGE, HEADER, FOOTER, or TEMPLATE. Edit the header and footer with the chrome tools. Edit a collection's template body with planeward-site-page-update (templatePageId from the collection). hideHeader: true and hideFooter: true hide the site header or footer on a page, independently (both default false).

Collections

ToolPurpose
planeward-site-collection-listCollections on a site: fields, slug, templatePageId, jsonLd, itemCount
planeward-site-collection-getOne collection
planeward-site-collection-createCreate with name, slug (URL prefix), fields, optional jsonLd. Also creates the TEMPLATE page with the name and first fields bound. A PAGE with the same slug is the index
planeward-site-collection-updatePatch name, slug, fields (send the full list), or jsonLd (null removes). Removing a field keeps stored values
planeward-site-collection-deleteDelete the collection, its items, and its template. Fails while another collection references it
planeward-site-collection-item-listItems, drafts included; optional search (name or slug) and status (DRAFT, PUBLISHED, ARCHIVED). Rows have hasUnpublishedChanges
planeward-site-collection-item-getOne item's draft (data, seo, slug), status, and contentVersion
planeward-site-collection-item-createCreate a draft with slug, data (name plus field keys), optional seo. publish: true also puts it live
planeward-site-collection-item-updatePatch slug, data, seo, or status (DRAFT unpublishes, ARCHIVED hides). Pass expectedContentVersion. publish: true puts the saved draft live
planeward-site-collection-item-deletePermanently delete itemIds; also removes them from reference fields. Returns deleted and referencesCleared
planeward-site-collection-item-publishPut itemIds live now through the published template. Needs one site publish first
planeward-site-collection-item-unpublishTake itemIds off the live site (status DRAFT)
planeward-site-collection-item-upsertCreate or update by slug, up to 20,000 rows. Existing items keep omitted fields and their status; new items are drafts; nothing is published. Up to 200 rows returns { kind: "inline", created, updated, failed }; more returns { kind: "job", jobId } — poll with planeward-job-get

Field types: text, richText, image, number, boolean, date, url, select, reference, multiReference, list. A list field has itemFields (1–8 { key, label, type: "text" | "richText" }) and holds up to 50 rows (an array of objects keyed by sub-field key). name, slug, seo, id, and url are reserved keys. Reference values take item ids or slugs in the target collection. jsonLd.type is DefinedTerm, SoftwareApplication, Article, or Product; map maps schema.org properties to field paths. New collections and template changes go live on the next planeward-site-publish; rolling back a site version does not change item content. Publishing, unpublishing, and archiving or deleting live items need site publish permission.

On the template, custom.bindings maps a block property (text, html, href, src, alt, darkSrc, poster, label) to a field path: name, {fieldKey}, {refField}, {refField}.name|slug|url|id|{key}, item.url|slug|name|id|publishedAt. Element options: navMenu takes custom.mobileStyle (popover or sheet) and custom.mobileCtas (up to 2 { label, href, variant: "primary" | "secondary" } shown at the bottom of the mobile menu). faq renders as a single-open accordion (bordered rows, chevron on the right). A themeToggle renders only when the theme has a dark palette. A collectionList block repeats its one container child per published item. An faq block binds to a list field with custom.bindings.entries = "<listFieldKey>"; custom.entriesQuestionField / custom.entriesAnswerField pick the sub-fields (default question / answer), and each item page gets FAQPage JSON-LD.

Page seo takes schemaType (WebPage, Article, AboutPage, ContactPage, CollectionPage) and, for Article, optional publishedAt. Article JSON-LD uses the site Organization from the crawl settings as author and publisher. See Collections.

Customers, contacts, pipelines, invoices, payments

Each set has list / get plus write tools when the key has the matching WRITE scope:

  • planeward-customer-*
  • planeward-contact-* (list filters by firstTouchSource; update takes dmOptOut, guardianConsent, guardianEmail)
  • planeward-sequence-list / -get / -stats / -enrollment-list / -create / -update / -archive / -enrollment-bulk-stop / -enrollment-bulk-pause and planeward-contact-sequence-get / -enroll / -stop / -pause / -resume (contacts scopes). A contact can have one open SALES enrollment and one open CLIENT enrollment; higher priority replaces lower in the same lane. lane on stop/pause/resume defaults to SALES when sequenceId is omitted. planeward-contact-sequence-get returns open.SALES / open.CLIENT plus deprecated SALES fields at the top level. Bulk pause/stop of more than 200 rows returns { jobId } — poll with planeward-job-get.
  • planeward-job-get (contacts read). Poll a bulk job (attendance_import, sales_import, sequence_bulk_stop, sequence_bulk_pause) until SUCCEEDED, FAILED, or CANCELLED.
  • planeward-event-list / -get / -create / -update / -delete, planeward-event-registration-list / -get / -update / -delete, planeward-event-register, planeward-event-attendance-set, and planeward-event-attendance-import (contacts scopes). Registration and attendance (ATTENDED, LEFT_EARLY, NO_SHOW, UNCLASSIFIED) replace webinar-* and att-* tags. Registration update patches attendance, join/leave times, or opportunityId (null unlinks). Delete unregisters; the contact and opportunity stay. Import rows match registrants by email; leaving before offerStartsAt counts as left early. More than 200 rows returns { jobId } — poll with planeward-job-get. Event create and update take productIds (up to 50), the products whose paid plans register buyers (Paid events); on update the list replaces the whole set, and leaving it out keeps the links. A newly linked product must be in the workspace and not archived. Setting or changing productIds also needs CATALOG_WRITE and the Commerce app on; a credential with contacts scopes only can still edit the event's other fields. Event reads return productIds, and registrations return paymentId (the payment that bought the seat, or null).
  • planeward-pipeline-* and planeward-pipeline-stage-* (stage-list is read-only; write adds create / update / delete)
  • planeward-opportunity-* (also move; opportunities share the pipelines scopes). Moving to a Lost stage needs closeReason; a nurture stage (isNurture) needs nurtureReason. Leaving a nurture stage (including Won and Lost) clears nurtureReason. qual* flags are the qualification checklist.
  • planeward-invoice-* (also finalize and mark-paid)
  • planeward-payment-* (no delete). List accepts source, sourceLabel, and externalRef. Create and update accept paidAt, when the money was received: an ISO-8601 datetime with seconds and an offset, such as 2026-11-01T09:30:00Z or 2026-11-01T17:30:00+08:00. On create it defaults to now for a completed payment, so send it to record a payment received earlier. On update, omit it (or send null) to keep the current paid date.
  • planeward-purchase-record / planeward-purchase-reverse (payments write). Record a completed sale from any checkout. Idempotent on externalRef; replay returns already_recorded. Optional siteVisit ({ siteId, visitorId }, the pw_site / pw_vid values from a linked domain link) credits the sale to that site visit; the response says siteVisit.credited (or reason: invalid, not_found) and the purchase is recorded either way. Reverse marks the payment refunded.
  • planeward-meta-conversion-list / -retry / -export and planeward-meta-settings-update (payments scopes). Site update accepts metaSendPurchases (default off). Purchases are never sent to Meta unless the site has a pixel, a CAPI token, and that switch on.

Invoice, payment, and opportunity amounts are integer minor units of the workspace currency. Resolve stageId with planeward-pipeline-stage-list, contactId with planeward-contact-list, and ownerMembershipId with planeward-workspace-member-list. Contacts include metaContext (siteId, at, hasFbp, hasFbc) — never raw cookies.

Expenses

Requires EXPENSES_READ; write tools need EXPENSES_WRITE. Amounts are integer minor units and spentAt is a YYYY-MM-DD date.

ToolPurpose
planeward-expense-listList expenses; optional search, from, to, categoryId (none = uncategorized), vendor
planeward-expense-getGet by expenseId, with adjustments and lock state
planeward-expense-historyRevision history with field-level changes
planeward-expense-category-listCategories and monthly budgets
planeward-expense-createLog an expense in an open month
planeward-expense-updateEdit an open-month expense; pass expectedVersion from get
planeward-expense-deleteSoft-delete an open-month expense
planeward-expense-adjustPost a signed adjusting entry against a locked expense

Expenses in closed months (books closed in the app) can't be edited or deleted. Use planeward-expense-adjust instead.

Products and plans

Requires CATALOG_READ (catalog:read); write tools need CATALOG_WRITE (catalog:write). These tools need the Commerce app and fail if it is off. They work with Community off. Prices are integer minor units of the workspace currency. Connectors authorized before these scopes existed must reconnect to get them, unless they were granted full access (all).

planeward-product-list and planeward-product-get also return the product's media: iconUrl (the icon, or null) and gallery, its product page gallery in display order. Each gallery item has an id and a type:

typeFields
imageurl
videourl, posterUrl (or null), mimeType, sizeBytes
youtubeurl (the watch link), embedUrl, posterUrl

File URLs are signed and expire in about an hour, so use them right away and don't store them; read the product again for fresh ones. Media is read-only over MCP: change it in the app (Commerce → Catalog → product → Media). Create and update ignore iconUrl and gallery.

ToolPurpose
planeward-product-listList products with checkoutForms; optional search, includeArchived
planeward-product-getGet by productId, with its plans and checkoutForms
planeward-plan-listList a product's plans by productId
planeward-plan-getGet by planId
planeward-product-createCreate a product: name, optional slug (derived from the name), shortDescription, longDescription, grantsCommunityAccess
planeward-product-updatePatch a product
planeward-product-archiveArchive or unarchive: productId, archived
planeward-product-deleteDelete a product with no customers or money records
planeward-plan-createCreate a plan: productId, name, price, compareAtPrice, interval (ONE_TIME, WEEK, MONTH, YEAR), intervalCount (1–36), maxCycles (2–120 or null), lifetimeAfterFinalCycle, allowMultipleSubscriptions, checkoutAccess, stripePriceId
planeward-plan-updatePatch a plan; omitted fields keep their stored value
planeward-plan-deleteDelete a plan with no customers or money records
planeward-plan-grantGive a customer free, lifetime access on any plan, unlisted ones included: customerId (from planeward-customer-list), planId. Returns subscriptionId. Later payments for the plan never touch the grant
planeward-plan-grant-revokeEnd the customer's active grant on a plan now: the same customerId and planId. Errors when there is no active grant. Paid subscriptions are left alone; they end through a refund or a staff cancel in the app

Product reads include a read-only checkoutForms list of the forms asked at checkout: formId, formName, timing (PRE or POST), display (how a PRE form is shown; null for POST), planId (null for a product-level form) and published (drafts are listed but don't apply). Attach or detach forms in the app. See Checkout forms.

Product reads also include two read-only checkout settings, changed in the app under Commerce → Catalog → the product → Settings: disabledCheckoutMethods, the payment methods its checkout never offers (STRIPE, XENDIT or RECEIPT; empty means every method the workspace has set up), and checkoutMobileOrder, what the checkout page shows first on phones and narrow screens (CHECKOUT_FIRST or DESCRIPTION_FIRST). See Payment methods and mobile layout.

grantsCommunityAccess is set on the product: buyers of any of its plans become members. It is one thing a product can give; files, links, courses and event tickets are set in the app on the product's Access tab, and aren't part of the tools. Turning it on needs the Community app on, a community created and community:manage, which only a full-access key or grant holds; turning it off needs only Commerce. checkoutAccess is public, or unlisted: sold to accepted waitlist buyers, through checkout links that target the plan, or either. A waitlist-only plan needs the product's waitlist on. See Sales journey.

Delete fails while a plan or product has customers (any subscription, past or active) or money records (payments, receipts, invoice lines, open checkouts). A product is also blocked by revenue-share entries and waitlist entries. The error lists what's blocking; archive the product instead. Deleting detaches attached forms and removes plan-only promo codes. Deleting a product also removes its plans, checkout links, affiliates and promo codes.

Channels and messages

  • planeward-channel-list / get / create / update
  • planeward-message-list (by channelId) / create / update / delete

Workflows

  • planeward-workflow-list / get / create / update / duplicate / delete / status, planeward-workflow-graph-update, planeward-workflow-run / run-get / run-list / run-retry, and planeward-workflow-credential-*
  • planeward-workflow-node-types lists every trigger, action, and flow node with its config schema and an example. Call it before planeward-workflow-graph-update. Each platform event in platformEvents carries payloadSchema, the JSON Schema of its trigger.data. *.updated events send { id, <parent ids>, old, new, changes }; see Webhooks.
  • A webhook trigger's config.path must be unique in the workspace. Omit it and graph update generates one. The URL is /api/webhooks/workflows/<workspaceId>/<path>.

See also

  • Authentication for headers, scopes, and rate limits
  • Webhooks for outbound events the same mutations enqueue
  • Task description content for the RTE document contract
  • REST API for HTTP equivalents

Webhooks

Outbound signed deliveries, event catalog, and URL rules.

Embedded projects

Secure iframe embed so host-site users can create and manage their own partitioned projects.

On this page

EndpointClaudeClaude.ai and Claude DesktopClaude CodeChatGPTEditors (Cursor, Windsurf, …)Any MCP clientTool catalogLookupsProjectsTasksTask templatesFormsSitesCollectionsCustomers, contacts, pipelines, invoices, paymentsExpensesProducts and plansChannels and messagesWorkflowsSee also