Docs Changelog Marketplace

The Manifest

The manifest is a JSON file describing your tile.

{
  "id": "acme.invoice-sync",
  "name": "Invoice Sync",
  "version": "1.0.0",
  "icon": "receipt",
  "capabilities": ["data.query", "connector.call", "settings.get", "storage.get", "storage.set"],
  "placements": ["main"],
  "size": { "w": 6, "h": 5, "minW": 4, "minH": 4 },
  "settings_schema": [],
  "connectors": [],
  "views": []
}

Fields

  • id: your tile's id. Tilelytix assigns the final web address, so two creators can both ship a tile with the same id.
  • version: semantic version such as 1.2.0.
  • icon: an icon key from the published list. See Icons.
  • capabilities: everything your script uses. Users accept exactly this list.
  • settings_schema: fields the user fills in when configuring. Types: text, url, password, checkbox, date, select (with an options list of { value, label }) and number (with optional min, max and step). Mark secret fields with secret: true, optional ones with required: false, and give a default with default. A field can appear only when another one has a certain value with show_if, for example { "key": "method", "equals": "multiple" } (or "in" / "not_in" with a list). Values are checked on the server against these rules when saved.
  • finance: for supported sources (WHMCS, Paymenter, Razorpay), lets the organization add your source's paid invoices, fees and refunds to its Tilelytix finance. It needs the finance.feed capability and an include_in_finance checkbox. Money is parsed by Tilelytix on the server, never by your script.
  • connectors: outside calls your tile may make. See Connectors.
  • views: named views a user can switch between. See Views.