Weblutions Documentation
Weblutions Main Site Contact Us Our Discord
FaxStore IconFaxStore

Weblutions Documentation / FaxStore / Registering Apps

Updated

Registering Apps

By Josh M. 1 mins 66

When an app is created it's recommended to have the app registered to ensure it's visible on FaxStore's staff panel and internally within the FaxStore application.

Register your app so it shows in the staff panel and other apps can find it. faxstore.registerExtension works the same as faxstore.apps.register:

faxstore.apps.register({
    id: 'myapp',
    name: 'My App',
    version: '1.0.0',
    author: 'Your Name',
    description: 'What the app does.',
    staffPage: {name: 'My App', link: '/staff/myapp', icon: 'puzzle-piece'}
}, __filename);

Option

Notes

name

Required. Shown on Integrations.

id

What other apps use to find yours, e.g. pushover. Use lowercase letters, numbers and dashes. If you leave it out, FaxStore makes one from the name, so My App becomes my-app. Don't change it after release, or apps that look yours up will stop finding it.

api

Functions other apps can call. See Using Other Apps.

staffPage

Adds a link to the staff sidebar and a button on Integrations: {name, link, icon}. icon can be a Font Awesome icon name (puzzle-piece) or a full class (fa-solid fa-puzzle-piece).

version, author

Shown on Integrations.

url

Adds a Learn More button on Integrations.

description, icon

Saved with your app, so other apps can read them.

register() returns true when your app is registered. If it can't register your app, it returns the reason and logs it to the console, for example when name is missing or another app already uses the id or name.

Pick an id that no other app uses. If two apps use the same id or name, FaxStore keeps the first one to register and skips the other. Apps start at the same time, so which one registers first can change between restarts.