Skip to main content

Marketplace

info

Enterprise Plan — This module is available on the Enterprise plan.

The Marketplace module is your platform's app store. Developers submit apps with a manifest, you scan and certify them through a moderation pipeline, and tenants install them with scoped permissions. Every install fires lifecycle hooks so apps can provision resources on activation, and you can retry failed hooks without reinstalling.

What's Included​

  • App catalogue — browsable listing of available apps with install counts, ratings, and monetization details
  • Submission pipeline — structured intake with manifest validation, automated security scanning, and moderation decisions
  • Certification and quality gates — per-app certification status and quality gate tracking
  • App installs — scoped permission grants and per-install configuration
  • Lifecycle hook events — install and uninstall webhook delivery with retry support
  • App ratings — aggregate rating display per app

Browsing and Managing Apps​

The app catalogue shows every published app along with install counts, average ratings, certification status, and pricing.

  1. Navigate to Marketplace > Apps to see the full catalogue.
  2. Click an app to view its manifest, publisher, support tier, and monetization model (for example, free, paid, usage-based).
  3. To add a new app directly (bypassing the submission flow), click New App, fill in the name, publisher, and description, and paste the app manifest as JSON.
  4. Set the Certification Status (pending, certified, rejected) and Quality Gate Status (review, passed, failed) and save.

To edit an existing app's metadata, manifest, or certification status, click the app name in the catalogue list, update the fields, and save. To permanently remove an app record from the catalogue, choose Delete from the app's detail page. Note that Delete removes the app entry itself — to remove a tenant's installed instance, use Uninstall from the Installs view instead.

Submitting an App​

The submission pipeline ensures every app goes through validation and a security scan before it reaches tenants.

  1. Go to Marketplace > Submissions and click New Submission.
  2. Provide the app name, publisher, and an App Key (a URL-safe slug). If you leave the key blank, it is generated from the name.
  3. Paste the complete Manifest as JSON. The manifest must include all required fields — the system validates it immediately and returns an error listing any missing fields.
  4. Submit. The submission enters the submitted state with moderation status pending_scan.

Scanning a Submission​

After submission, run a security scan to check for policy violations:

  1. From Marketplace > Submissions, click Scan next to the submission.
  2. The scan runs automatically and records the result. If issues are found, the submission moves to needs_review or blocked.

Approving or Rejecting​

  1. Review the scan results and submission details.
  2. Click Approve to publish the app to the catalogue. The system verifies the scan passed before approving.
  3. Click Reject and enter a reason if the submission does not meet your standards. The submitter can revise and resubmit.

Installing Apps​

Once an app is published, tenants can install it with specific permission scopes and configuration.

  1. Go to Marketplace > Installs and click Install App.
  2. Select the app from the list.
  3. Enter the Scopes Granted as a comma-separated list of permissions you want to allow for this install. Only grant the minimum required.
  4. Paste any install-specific Configuration as JSON (for example, API keys, webhook URLs, or feature flags).
  5. Click Install. The system fires the app's install lifecycle hook and logs the event.

Lifecycle Hook Events​

When an app is installed or uninstalled, Marketplace fires a webhook to the app's configured hook endpoint. This lets apps provision accounts, seed data, or clean up resources automatically.

If a hook delivery fails, it appears in the Failed Hooks list on the dashboard:

  1. Go to Marketplace > Installs and locate the install with a failed hook.
  2. Click Retry Hook to redeliver the event. The system logs each attempt with status and response details.

You can monitor hook health from the Marketplace dashboard, which shows a count of failed hook events at a glance.

Uninstalling Apps​

  1. Go to Marketplace > Apps or Marketplace > Installs.
  2. Click Uninstall next to the installed app.
  3. Confirm the uninstall. The app's uninstall lifecycle hook fires, and the install record moves to an uninstalled state.

For programmatic access to apps, submissions, installs, and hook events, see the Marketplace API Reference.