Support FAQs

Use the optional supportFAQ field in your add-on manifest to answer common support questions. These FAQs improve ServiceM8 Add-on Store recommendations and helpdesk guidance.

Describe who your add-on serves in the separate optional addonTargetAudience field. Identify geographic coverage (global, country-specific or region-specific), industries and business size. For example, Australia/NSW means New South Wales, Australia. When supplied, this must be a nonblank plain-text string without HTML or Markdown, limited to 2,000 Unicode characters. Omit it when unavailable.

addonTargetAudience and supportFAQ are independent: you can supply either, both or neither.

Format and limits

supportFAQ is an ordered array of 1–10 objects, each containing a question string and an answer string. Omit supportFAQ when you have no FAQs to supply; do not use an empty array.

You choose all questions and their order, up to 10 entries total. No fixed first question is required.

All questions and answers must be nonblank plain text, without HTML or Markdown. Each answer is limited to 2,000 Unicode characters. The existing 64 KB total encoded manifest limit still applies to the complete manifest, including FAQs, other fields and JSON syntax; JSON escaping can increase the encoded size.

Example manifest

Replace the sample audience and support answer with accurate details for your add-on:

{
  "$schema": "https://api.servicem8.com/api_1.0/addonsdk/manifest-schema/v1.json",
  "name": "Example Scheduling Add-on",
  "version": "1.0",
  "supportEmail": "support@example.com",
  "addonTargetAudience": "This add-on serves plumbing and electrical businesses in New South Wales, Australia (Australia/NSW), with 1 to 20 staff.",
  "supportFAQ": [
    {
      "question": "How do I get help with a scheduling problem?",
      "answer": "Email support@example.com with the job number and a description of the scheduling problem."
    }
  ]
}

The $schema declaration enables validation in JSON Schema-aware editors. See Manifest validation for endpoint details and editor setup. Your add-on's release version is independent of the schema version, and server-side checks still apply when the manifest is uploaded.