Add-on: Partner guide

Everything you need to know about building and launching an Add-on integration with Storeganise, from initial contact through to marketplace listing.

Note: By using Storeganise or the Storeganise API, you agree to the Storeganise Subscription Terms of Service and Privacy Policy.

What is an Add-on?

The Storeganise Add-on framework lets you build integrations that extend the platform for self-storage operators. Add-ons are webhook-based: your server listens for events in Storeganise (move-ins, payments, bookings) and responds by syncing data with your system or triggering actions in an external service. Common examples include payment gateways, access control systems, and accounting integrations.Key terms used in this guide:
  • Developer/Partner: you, the third party building the Add-on
  • Operator: the self-storage facility using your Add-on on Storeganise
  • Customer: the operator's customers
What operators see when they install your Add-on
Operators interact with three things:
  • Add-on description: explains what your Add-on does and its benefits
  • Setup instructions: a step-by-step guide for configuring the integration
  • Custom fields: form fields you define for collecting credentials or configuration options specific to each operator
What you build
The following is invisible to operators but powers everything:
  • Webhook endpoints that receive and process events from Storeganise
  • Webtasks that run during installation and management of the Add-on
  • API integration logic connecting Storeganise data to your system
  • Error handling for network failures and API errors
For technical details on building these components, see the Add-on technical reference.

Add-on states

Once installed, your Add-on can be in one of three states:
  • disabled   : Storeganise will not call your webhooks, and your system cannot access the operator's account
  • paused    : Storeganise will not call your webhooks, but your system can still access the account via the API. This is the default state after installation.
  • enabled    : Storeganise calls your webhooks and your system has full API access

What the partnership involves

What Storeganise provides
  • A dedicated development instance at [youraddonname].storeganise.dev     
  • Starter code packages for common integration types
  • API documentation, best practices, and webhook event reference
  • An assigned integration partner as your primary technical contact
  • Production deployment support; Storeganise handles all production infrastructure
Note: Storeganise can assist with straightforward technical queries, but ongoing API support may be subject to fees.
What you're responsible for
  • Building and testing the Add-on in your development instance
  • Writing the operator-facing Add-on description, setup instructions, and helpdoc
  • Preparing a working demo for certification
  • Monitoring and responding to support escalations after launch
  • Managing updates through your development instance before production deployment
What you'll need
  • Technical expertise in web development and API integration
  • Understanding of webhook-based architectures
  • Ability to host and maintain server-side code
  • Time to commit to development, testing, and writing operator documentation

The development process

Phase 1: Initial contact
Contact Storeganise at support@storeganise.com to express your interest in building an Add-on. Include:
  • A brief description of your integration and industry category
  • The target use cases or customer needs it addresses
  • How operators on the Storeganise platform will benefit
What happens next:
  • Storeganise assigns you an integration partner who becomes your primary technical contact
  • You receive access to a dedicated development instance at [youraddonname].storeganise.dev     
  • On first login, you'll accept the Terms of Service and Privacy Agreement; no separate legal process is required

Reference Add-on: Your development instance includes the Xero Add-on (disabled, for reference only). Review it for examples of well-written descriptions, clear operator setup instructions, and professional presentation of custom fields.

Phase 2: Development resources
Storeganise provides starter code packages as ZIP files. Two starters are available:
  • Payment/Billing Add-on (addon-custom-billing-starter     ): for payment gateways and billing integrations. Includes OAuth flows, payment method management, and billing event handlers.
  • Access Control Add-on (addon-access-control-starter     ): for lock systems and access management. Includes move-in/move-out handlers, permission management, and webtask examples.
If your integration doesn't fit either type, Storeganise will provide the most relevant starter for your use case.Each starter includes a basic server setup, webhook handler structure, event mapping examples, sample webtasks, environment variable templates, and file structure documentation.The following documentation is available in your dev instance:
  • API documentation at [youraddonname].storeganise.dev/api/docs     
  • API best practices and FAQs
  • Webhook events reference
Phase 3: Build and test
During development, you are responsible for:
  • Building the Add-on using the starter package as your foundation
  • Testing all functionality thoroughly in your development instance
  • Writing the Add-on description and operator setup instructions
  • Creating an operator-facing helpdoc to be published on the Storeganise help site
  • Preparing a demo of your working Add-on
Stay in regular contact with your integration partner throughout. Raise questions early rather than making assumptions.

Certification and launch

Phase 4: Certification
When your Add-on is complete and working in your dev instance, notify your integration partner. They will send you a certification checklist covering:Required deliverables:
  • Working demo showing the complete flow: operator installation, configuration, and usage
  • Add-on description with a clear value proposition, features, and limitations
  • Setup instructions or a link to your helpdoc
  • Operator-facing helpdoc covering installation, configuration, and troubleshooting
  • Partner page information: company overview, logo, contact details, and branding assets
Technical requirements:
  • All relevant webhook events handled correctly
  • Comprehensive error handling for network failures and API errors
  • Multi-site support tested, if applicable
  • Webhook responses completing within the 30-second timeout
  • Nominated email address for support escalation
  • Nominated email address for leads sourced through the Storeganise website
Your integration partner reviews your submission and either approves the Add-on or provides specific feedback for improvements.
Phase 5: Production deployment
After approval, Storeganise coordinates deployment with the internal development team. You don't need to manage any production infrastructure. Once deployment is complete, you'll be notified and a check-in is scheduled after one week of production use.
Phase 6: Marketplace listing
Once live, your Add-on is published to the Storeganise Add-on marketplace, your partner page is added to the Storeganise website, and a changelog entry announces the new integration. Ongoing support works as follows:
  • Bug reports and updates follow established processes with your integration partner
  • Customer queries from operators are forwarded to your nominated support address

After launch

Managing updates
All changes must be made and tested in your development instance before going to production. This includes Add-on descriptions, setup instructions, custom fields, webtasks, webhook configurations, and server code. Once verified, notify your integration partner to coordinate production deployment.
Support escalation
Your integration partner remains your primary contact after launch. Operator support queries are forwarded to your nominated support email address.

Tips for a smooth partnership

  • Start with the reference Add-on. Review the Xero Add-on in your dev instance before writing your own description or setup instructions; it sets the quality bar.
  • Use the starter package. Don't build from scratch. The starters handle the boilerplate so you can focus on your integration logic.
  • Write documentation for operators with no prior knowledge of your system. Include screenshots for complex steps and provide troubleshooting guidance for issues they're likely to face.
  • Test edge cases, not just the happy path. Cover error scenarios, network failures, and multi-site configurations before submitting for certification.
  • Communicate early and often. Regular check-ins with your integration partner prevent small blockers from becoming big delays.
  • Don't rush to production. Incomplete certification submissions and poor demos slow down the review process. Test thoroughly before notifying your integration partner.
  • Prepare a comprehensive demo. It should show the complete flow: operator installation, configuration, and a working example of the integration in action.
  • Submit a complete certification checklist. Incomplete submissions result in back-and-forth delays. Go through every item before submitting.

Getting started

Ready to build an Add-on? Contact Storeganise at support@storeganise.com to express your interest. Include a brief description of your integration, your industry category, and the target use cases you're addressing.Once you reach out, your assigned integration partner becomes your primary resource for technical guidance, troubleshooting, and certification support throughout the process.
Jump to
Related articles
API FAQ
Webhooks
Integrate with any access control system using Addons/Webhooks
Add-ons: Technical reference
Add-on: Partner guide