Getting Started with Flowlu Custom Applications

This guide provides an overview of how to create, test, and distribute custom applications for Flowlu. 

What you need before you start

Before building a custom application for Flowlu, make sure you have:

• a Flowlu account,

• a clear understanding of whether your application will be private or public,

• familiarity with web technologies (HTML, CSS, JavaScript, backend services if required),

• access to the Flowlu API documentation.

Choose the application type

Flowlu supports two types of custom applications:

• Private applications
  Intended for internal use or limited distribution. Private applications are not listed in the Marketplace (Flowlu Apps) and do not require moderation.

• Public applications
  Listed in the Flowlu Marketplace (Apps) and available to other Flowlu customers. Public applications must pass moderation before publication, and each new version is reviewed.

Before starting development, decide which type best fits your use case.

See Private and Public Applications for details.

Define functionality and integration points

Next, define what your application will do and where it will appear in the Flowlu interface.

Examples include:

• adding a menu item or page,

• embedding a widget in entity cards,

• adding a tab to CRM records or tasks,

• displaying a dashboard widget,

• integrating with external systems via API and webhooks.

Available integration points are predefined and must be declared in the application manifest.

See Application Integration Points in the Flowlu Interface for supported locations.

Define permission scopes

Applications can access Flowlu data only through approved permission scopes.

Before writing code, determine:

• which modules and entities the application needs access to,

• whether read-only or full access is required.

Scopes must be declared in the application manifest and approved during installation. Missing or incorrect scopes will prevent API access and webhook creation.

See Permission Scopes and Data Access for details.

Create the application manifest

Each application must include a manifest.json file that defines:

• application metadata,

• permission scopes,

• integration points,

• configuration options,

• external URLs (if applicable).

The manifest is required for installation and publication and is validated automatically by Flowlu.

See Application JSON Manifest (Example) for structure and field descriptions.

Build the application

Depending on the application type, you may build:

• an embedded web module that runs in the browser and uses the Flowlu JS SDK,

• an external service hosted on your own infrastructure and integrated via API and iframe,

• or a combination of both.

All interaction with Flowlu must go through the public API and follow authentication and permission rules.

See:

• API Access for Custom Applications

• Authentication and Authorization

Test the application

Before distribution or submission, test the application in a Flowlu account:

• validate the manifest structure,

• verify integration points render correctly,

• confirm API access works as expected,

• test permission restrictions and error handling.

Incomplete or unstable applications should remain private until they are production-ready.

Install or submit the application

• Private applications can be installed directly into a Flowlu account without marketplace publication.

• Public applications must be submitted for moderation before being listed in the Marketplace.

Once approved, public applications become available to other Flowlu users.

See How Applications Are Built and Application Lifecycle for details.