/
Documentation

Marketplace Submission

Register your add-on, fill in the manifest, test in draft mode, and submit for review.

The Publishing Flow

text
Draft → Test → Submit for Review → Admin Reviews → Published
  ↑                                                    │
  └────── Rejected (fix issues, resubmit) ←───────────┘

Step-by-Step Registration

1

Go to the Developer Portal

Navigate to /developers and click "Marketplace Add-ons" in the sidebar.

2

Click 'New Addon'

Fill in the manifest form:

3

Fill in Basic Info

  • App Name — clear, descriptive (e.g., "WhatsApp Invoice Sender")
  • Short Description — one line for marketplace cards (max 100 chars)
  • Category — Communication, Analytics, Automation, Finance, Productivity, Integration, Other
  • Launch URL — your deployed HTTPS URL
  • Icon URL — 128×128 PNG (shown in marketplace)
4

Select Permissions

Choose only the scopes your add-on actually needs. Fewer permissions = more installs (users trust minimal-access apps more).

Principle of least privilege

If you only read invoices, don't request invoices.write. You can always request more scopes later and existing installations will need to re-approve.

5

Select Placements

Choose where your add-on appears in SyncBooks:

  • navigation.item — sidebar nav (most common)
  • dashboard.widget — card on dashboard
  • invoice.actions — button on invoice pages
  • customer.sidebar — panel next to customer detail
6

Set Pricing

  • Free — no charge (great for building user base)
  • Monthly — recurring charge (minimum GHS 10/month)
7

Create (Draft Mode)

Click Create. Your add-on is now in Draft status — only you can see and test it.

Testing in Draft Mode

  1. Go to your organization's dashboard
  2. Navigate to Add-ons in the sidebar
  3. Your draft add-on appears in the list (marked as draft)
  4. Click Open to test it with real data
  5. Verify all features work correctly

Submitting for Review

When you're confident everything works:

  1. Go back to /developers → Marketplace Add-ons
  2. Find your add-on and click Submit
  3. Status changes to In Review
  4. A SyncBooks admin will review your submission

What reviewers look for:

  • ✅ Launch URL loads and works (not broken/blank)
  • ✅ Description accurately describes functionality
  • ✅ Permissions requested match actual usage
  • ✅ No malicious code or data exfiltration
  • ✅ UI is functional and doesn't crash
  • ✅ Responsive on mobile

Common rejection reasons:

  • ❌ Launch URL returns 404 or error
  • ❌ Requesting excessive permissions not used
  • ❌ Broken UI or JavaScript errors
  • ❌ Misleading description
  • ❌ No clear value proposition

Rejection isn't permanent

If rejected, your app goes back to Draft status with feedback. Fix the issues and resubmit.

After Publishing

Once approved, your add-on is live in the marketplace. Organizations worldwide can:

  • Discover it by browsing or searching
  • Install it with permission consent
  • Configure access for their team
  • Rate and review it

Next Steps

Previous

Deployment

Next

Pricing & Revenue