Skip to content
flowplanDocumentationCommunityMarketplaceStart page

Projects and automation

Marketplace

In the Flowplan Marketplace (marketplace.flowplan.org) people share what they built in Flowplan: document and database templates, workflows, whiteboard templates, appearances and rules for automatic links. Browse it and take templates over into your instance with one click – or publish your own. The templates that come with Flowplan are there too (public domain, CC0).

6 min readNew Checking an import

On this page
  1. What you can share
  2. Publishing
  3. Taking over
  4. Checking an importNew
  5. Privacy
  6. Switching it off

Browsing and taking over need no marketplace account. To publish, you sign in there with GitHub or an e-mail link. Every submission is reviewed before it becomes public.

What you can share

KindWhere in FlowplanWho may publishWhat taking it over creates
Document and database templatesTemplate gallery → Your templateswhoever created the template, ownersa template in the gallery (for the workspace, a space or only you)
WorkflowsHead of the workflow page (Marketplace icon)whoever may edit the workflowa new workflow page – paused, as a draft
Whiteboard templatesWhiteboard → Templates → Own templateswhoever created the template, ownersan own whiteboard template of the workspace
AppearanceSettings → Appearanceownersreplaces the workspace's appearance (with its typefaces)
Automatic linksSettings → Automatic linksownersthe rules are added to the existing ones

Guests never publish anything.

Publishing

  1. Choose Publish to the marketplace … on the template, the workflow or in the settings.
  2. In the dialog, check the title, the summary (German and English), category, tags and language, and add up to four preview pictures (PNG, JPEG or WebP, 1 MB each at most). For documents and databases a screenshot pays off – Flowplan doesn't create one itself.
  3. Open in the marketplace: Flowplan builds the file, opens the marketplace's submit page in a new window and hands it over there. You sign in, choose the licence (default CC BY 4.0, also CC0 and MIT), confirm that you hold the rights to the content and submit.
  4. Or Download as a file: upload the .flowplan-template file on the submit page yourself.

What is never included: a workflow's credentials, runs and webhook addresses, the address of your instance, names of people, pictures uploaded to a whiteboard (only pictures with an https address go along) and record cards. A workflow's references to pages, databases and people are matched by name on import or stay empty. For appearances with own typefaces: only publish typefaces whose licence allows passing them on.

Taking over

  1. On a template's page in the marketplace, choose Open in Flowplan. Without a saved instance it says Open in app.flowplan.org – for the hosted Flowplan one click is enough. For your own instance, choose Use your own instance … and enter its address once (e.g. https://flowplan.example.org); from then on the button says Open in flowplan.example.org, and Change instance brings the field back. The address stays in your browser only.
  2. Flowplan opens in a new window and receives the template. If you're not signed in, sign in first – the template waits in your browser meanwhile (up to 24 hours).
  3. A preview shows the title, kind, author, licence and what will be created. For workflows you see every node, the external services it talks to, whether it uses AI steps or sends e-mail – and what you need to set in the editor after the import.
  4. Choose the workspace and space (for workflows also the parent page) and Take over.

When you come to the marketplace from Flowplan – via More templates in the marketplace in the template gallery, Open the marketplace under Settings → Import & export, or when publishing – the marketplace remembers your instance by itself and briefly shows Instance saved:

· change once. You don't have to type the address at all.

Workflows always arrive paused, as a draft. Check them, fill in what's missing and activate them yourself.

Take over a downloaded .flowplan-template file under Settings → Import & export → Template from the marketplace, or in the template gallery with Import template.

Flowplan checks every file again itself: size (25 MB at most), the file's structure, paths, compression and the content of each kind – just like an import from another instance.

Checking an import New

Before a submission goes public, the marketplace team checks it in flowplan-admin in two ways: a security scan looks for risky content in the package – such as executable files, scripts in documents or attachments, credentials, personal data or workflow steps that call internal addresses –, and an import test runs the import in a test workspace of its own on a Flowplan instance. A package with a blocking finding is only published when the team gives an explicit reason.

You can run the import test yourself too: POST /api/marketplace/check tells whether a package would import on your instance.

  1. Flowplan reads the package exactly like the import: size (25 MB at most), ZIP safety, template.json, the kind's format.
  2. Then a dry run in the workspace: the kind's import runs inside a database transaction that is always rolled back – the template and a page made from it with its properties, views, records and attachments, the whiteboard template, the appearance with its typefaces, the link rules. That also catches errors that only show when things are created (duplicate ids in a database, storage). Workflows are read, matched against the workspace and validated, but not created.

Nothing stays behind: no page, no file, no log entry, no webhooks or notifications.

curl -X POST https://flowplan.example.com/api/marketplace/check \
  -H "Authorization: Bearer fp_…" \
  -F [email protected] -F workspaceId=<workspace ID>
  • workspaceId (optional): the workspace of the dry run – you must be a member (not a guest); templates need edit rights, the appearance and link rules owner rights. Without it Flowplan uses a workspace you own, otherwise one you can edit.
  • dryRun=0: only read, no dry run.
  • The answer is 200, also when the package would not import, with ok: true|false, kind, creates (what would be created: templates, pages, fields, views, records, files, nodes, items, fonts, rules, theme), errors and warnings (each code, de, en, maybe at) and dryRun (ran, rolledBack, ms).
  • Limits: 25 MB per package, 30 checks in 10 minutes per person. When the marketplace is switched off, the endpoint answers 404.
  • API tokens need the permission Marketplace check (see API and webhooks).

For flowplan-admin: create a test workspace in an account of its own, a Read only token with Marketplace check there, and set the address, the token and the workspace ID as MARKETPLACE_IMPORT_CHECK_URL, MARKETPLACE_IMPORT_CHECK_TOKEN and MARKETPLACE_IMPORT_CHECK_WORKSPACE in flowplan-admin.

Privacy

  • Your instance never connects to the marketplace. The hand-over runs in your browser between the two windows; Flowplan only sends to the configured marketplace address and only accepts something from there.
  • The marketplace's server doesn't learn your instance's address. Flowplan adds it to its marketplace links only after the #, a part browsers never send to a server; the marketplace keeps it in your browser and removes it from the address bar right away. It only counts anonymously how often a template was downloaded or opened in Flowplan – without IP addresses and without cookies for visitors.
  • When you publish, only the file you saw in the dialog goes to the marketplace.

Switching it off

Admin only

Administrators switch the marketplace off for the whole instance under Administration → Extensions & domains → Marketplace. Flowplan then shows no marketplace buttons and accepts no templates.

The environment works too: FLOWPLAN_MARKETPLACE_URL=off switches the marketplace off, another address (e.g. a marketplace of your own) replaces https://marketplace.flowplan.org.

Was this helpful?
YesThanks!
No – tell us what's missing

Found a mistake or something missing?Edit on GitHub