Skip to content

Build an app

App manifest reference

On this page

The manifest describes your app as JSON. In the developer console, My apps → Create an app opens the studio: a template, a blank app or Paste a manifest, then one page with Name & look, What it does, Connect and Listing, a live preview, and Manifest to edit the JSON itself (both stay in step). The app is saved as a private draft once you continue past Name & look, and as you go after that. An app's page is the same studio, with Credentials, Installs and testing and Review and versions too. From scripts and AI assistants, check a manifest with developers.apps.manifest.validate (every problem with its field and the step that edits it, nothing saved), then send the whole manifest to developers.apps.create or developers.apps.update. A company that installs your app gets the manifest of the version Bizisy approved; test installs use the draft.

JSON
{
  "manifest_version": 1,
  "name": "Payroll Sync",
  "slug": "payroll-sync",
  "short_description": "Sends hires and leavers to your payroll.",
  "long_description": "Keeps your payroll provider in step with Bizisy.\n\nNew hires, job changes and leavers arrive in minutes.",
  "group": "payroll",
  "developer": { "name": "Example Payroll Ltd", "website": "https://payroll.example.com" },
  "links": {
    "support": "mailto:help@payroll.example.com",
    "privacy": "https://payroll.example.com/privacy",
    "terms": "https://payroll.example.com/terms",
    "docs": "https://payroll.example.com/docs/bizisy",
    "pricing": "https://payroll.example.com/pricing"
  },
  "oauth": {
    "redirect_uris": ["https://payroll.example.com/oauth/bizisy/callback"],
    "install_url": "https://payroll.example.com/oauth/bizisy/install"
  },
  "scopes": ["people:view"],
  "webhooks": { "url": "https://payroll.example.com/webhooks/bizisy", "events": ["person.hired", "person.terminated"] }
}

Fields#

FieldRules
nameAt most 40 characters.
slug3–40 lower-case letters, digits and hyphens, starting with a letter; your listing's address (developers.bizisy.com/apps/<slug>). Unique across Bizisy; it can't change once listed.
short_descriptionOne line, at most 100 characters.
long_descriptionAt most 4000 characters of Markdown-lite: a blank line starts a paragraph, - starts a list item, and **bold**, *italic* and `code` work. Nothing else: no links, images, headings or HTML (they show as typed).
accentOptional: your app's colour as #rrggbb (the console picks it from your logo). The directory shows it behind your initials and around your icon.
groupWhere it is listed: chat, workspace, tasks, payroll, recruiting, documents, dev, automation or country.
developerYour name (a company or a person) and your website.
linkssupport (an https:// page or a mailto: address) and privacy are required; terms, docs and pricing are optional.
oauth.redirect_uris1 to 10 exact callback addresses.
oauth.install_urlWhere Install sends the browser. Bizisy adds ?iss=<the company's address>; start the OAuth flow from there.
scopesWhat the app may do: see Scopes.
webhooksnull, or a receiver url and the events it wants (event types).

Every address must be https:// with a public host name, never a Bizisy address. While the app is private, http://localhost (or 127.0.0.1) is accepted for the redirect and install URLs, so you can build on your own machine; a submission needs https:// everywhere.

Icon and screenshots#

Upload an icon (square; shown at 512×512) and up to 4 screenshots (shown at 1280×800) in the console (your app → Manifest) (JPEG, PNG or WebP, at most 2 MB; Bizisy re-encodes them and drops all metadata). An icon is required to submit.

Limits#

An owner (you, or an organization) has at most 10 apps.

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs