PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome
CRM overviewCustomersContactsFormsAnalytics and public resultsForm appearancePipelinesInvoices and paymentsClient portal

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

CRM

Forms

Public intake forms that create contacts and optional opportunities.

Open CRM → Forms. A form is a published intake page. Someone fills it in; Planeward stores the submission and can upsert a contact.

Build and publish

New form, then use the builder: questions on the left, preview on the right. Each question has a unique id and an editable slug (the public input name, like username).

Phone questions have a Default country code: the country the code picker starts on. Leave it on Visitor's location to start from the visitor's location, or their browser language when it is unknown. People can always pick another country.

Settings maps name / email / phone onto CRM write-back, and can create a customer or opportunity. When a submission matches an existing contact, an answered name or phone replaces the contact's; a question left blank keeps what the contact has. Appearance sets colors, a Storage logo, and custom CSS. Share has the public address, iframe and script snippets, allowed origins, and the public results link.

Publish from Settings. The public address is /forms/{workspaceId}/{formId} on the Planeward app, and the form’s slug on the sites domain. Turn Public link off on Share when the form should only appear on your sites and in embed snippets.

Three ways to collect answers

  • Standalone page — optional. /forms/{workspaceId}/{formId} on the Planeward app, plus the form slug on the sites domain. Off when Public link is off
  • Sites block — drop Contact form on a page and pick a published form. This stays available when the public link is off
  • Embed — iframe or script from Share. This stays available when the public link is off. Query options include theme, accent, css, prefill[slug], and UTM parameters

Submissions land on the form’s Submissions tab and link through to the contact or opportunity they created. The Analytics tab charts the answers to every question. See Analytics and public results.

Export submissions

On Submissions, open Export in the table toolbar and pick CSV or JSON. You get every submission that matches the current search and filters, not just the page you see. One export holds up to 50,000 rows; past that, narrow the filter.

CSV columns, in order:

  • Submitted at, Status, Source, Name, Email, Phone. Name, email and phone come from the linked contact
  • One column per form field, headed by the field label. Option fields show the option label. Checkboxes show Yes/No
  • Answers to fields you later removed from the form
  • Submission ID, Contact ID

When two columns share a label, the later ones get " (2)", " (3)". Dates are ISO 8601 in UTC. Values that look like spreadsheet formulas start with ', so the file is safe to open in a spreadsheet.

JSON is an array of objects with the same keys. Numbers, true/false (checkboxes included) and multi-select lists keep their types.

Filter by event registration

When the form is linked to an event, the Submissions table shows a Registration filter. It keeps only submissions from people registered for that event. A form is linked when the event uses it (the event's Form setting), or when the form's Register for event setting points at the event. With several linked events, pick Registered for any linked event or one event.

Matching is by contact. A submission with no linked contact never matches, and someone whose registration was cancelled no longer matches. The count, pages and export all follow the filter. You need permission to view contacts as well as forms to use it. The Analytics tab and the public results page have the same filter.

Export event registrations

On an event's page, the Registrations table has the same Export menu (CSV or JSON). It follows the attendance filter (the stat tiles) and the search.

Columns: Name, Email, Phone, Registered at, Attendance, Joined at, Left at, Contact ID. Attendance is the raw value, like ATTENDED or NO_SHOW. The headers match what Import attendance recognises, so you can edit an export in a spreadsheet and import it back.

Attribution

A submission's UTMs are first touch. On a Planeward site, they come from the visitor's earliest tagged pageview on that site, not the page the form was submitted on. They're stored on the lead and become a new contact's first touch, so someone who landed from campaign A and signed up from campaign B is credited to A. An existing contact's first touch is never overwritten.

With no earlier tagged pageview (a first visit, or an embed or standalone page outside a site), the UTMs on the form's URL are used.

A submission's page shows both: First touch, and Submitted from for the submit page's own UTMs when it had any.

Over the API, MCP, and in workflows, metadata.utm is the first touch and metadata.pageUtm holds the submit page's UTMs (only when present). Submissions from before this change keep the submit page's UTMs in metadata.utm; they were not rewritten.

Community apps

Turn on Show in community apps in the form's Settings (under Publish) to let community apps you installed list the form and submit it for members. Their submissions land on Submissions like any other and run the same workflows. Apps never see forms with the toggle off, and never read stored answers. Apps see the questions and the respondent and appearance settings, not CRM routing such as the pipeline, tags or linked event.

Consent is never recorded from an app. The answers are stored on the submission, but marketing consent, guardian consent and the guardian email are not set on the member's contact; only the member can give consent, by filling in a form themselves. The same applies to submissions through the API.

Using a form in checkout

Attach a published form to a product or plan with the Checkout purpose to ask it before or after a buyer pays. Answers arrive as normal submissions on the form's Submissions tab, and Form submitted runs for each. Only answers given at checkout count: a submission through the form's public link, an embed, a site, the API or MCP never satisfies it, even for the buyer's email. See Checkout forms.

A checkout form doesn't need an email question. The buyer is signed in, so the answers go on their own contact, and the buyer's email fills the form's mapped Email field, which is hidden from them. Answers to the mapped name and phone questions update that contact and its customer. Community onboarding forms work the same way for the new member.

Workflows

Form submitted starts a workflow. input.data.id is the submission. Get submission loads the answers; Get form loads the published definition. Create / update / get form nodes can draft or publish a form from the graph.

Next

  • Analytics and public results
  • Contacts
  • Pipelines
  • MCP

Contacts

People you sell to. Link them to a customer account when you bill.

Analytics and public results

Charts for every question, and a private link that shares the results.

On this page

Build and publishThree ways to collect answersExport submissionsFilter by event registrationExport event registrationsAttributionCommunity appsUsing a form in checkoutWorkflowsNext