Substratal Apps Substratal Apps Hub specs
GitHub

Help Guides

Developers

Registering and managing applications

An Application is software you build on Substratal: a web, iOS, Android or desktop app. Substratal handles its users, access, roles, settings and notifications.

Register

Anyone with a verified email can register an app from Register application. Choose a slug carefully: it's permanent, and it appears in your app's ID (app_<slug>), its permission names (app.<slug>.*) and its role IDs. Self-registered apps start as Pending review and don't appear in the catalog until approved.

Configure

  • Redirect URIs. Exact-match https:// URLs, or your native app's custom scheme (com.example.app:/callback). localhost is allowed only for test-mode apps.
  • Settings schema. The per-user settings your app stores in Substratal, typed and validated on every write.
  • Permissions & roles. Your app.<slug>.* permissions, your role names, and which permissions each role grants.
  • Push credentials. Your APNs key, FCM service account, or Web Push VAPID keys, so Substratal can deliver your notifications.

Your backend's credentials

Create an app-scoped API key for your backend (API Keys) and subscribe to the required access.revoked and role.removed webhooks (Webhooks). See Receiving webhooks.

Review lifecycle

Status Meaning
Pending review Submitted, waiting for staff. The target is 5 business days.
Approved Live in the catalog
Rejected Staff left notes. Edit any setting to resubmit.
Suspended Paused by staff. No new access grants or launches, but existing access isn't removed.

Screens in this guide

APL-01 · Applications APL-02 · Register application APL-03 · Application — Overview APL-04 · Settings schema APL-05 · Permissions & roles APL-06 · Review APL-07 · Push credentials BIL-04 · Tenant & infrastructure

Last updated 2026-10-23 · Built 2026-10-25 from a9ef3be · API 1.0.0-draft.13 · Substratal-Version: 1