For an app to be listed and available for installation by merchants, it must meet the following set of requirements. These ensure a consistent, secure, and high-quality experience for merchants across the entire app lifecycle — from installation to daily use.
These requirements are subject to change as we continue to evolve the Smile app ecosystem and developer platform. Apps must meet any new requirements to remain listed and available to merchants.
Installation and setup
Apps must provide a reliable, intuitive installation experience across all supported entry points.
- The app must be installable from both Smile and the partner’s platform (e.g. initiated from Smile embedded in Shopify, or initiated from the partner integration).
- If a merchant denies required permissions during installation, the app must display a clear, actionable error message.
- All OAuth installation and redirect URLs must be valid HTTPS links.
Functionality and quality
Apps must provide merchants with a functional, secure, and rewarding experience that meets Smile’s quality standards.
- The app must use activities to reward customers for completing rewardable actions (e.g. leaving a review). Apps must not issue points transactions directly unless the desired experience is not achievable using activities.
- OAuth access scopes must correspond directly to the functionality the app provides — do not request access scopes that are not required.
- Webhooks must only be configured if they directly support functionality provided by the app.
- Webhook request URLs must be valid HTTPS endpoints.
App listing
App listings are the first impression merchants have of your integration. They should be professional, accurate, and consistent with Smile’s brand and tone.
App icon
- The app icon must be square and between 200x200 and 1000x1000 pixels.
- The icon must not have a transparent background.
App name and website
- The app name must be accurate, properly capitalized, and reflective of the integration.
- The app website must be a valid HTTPS URL that directs to the app’s main landing page.
Overview and features
- The app overview must be concise — no more than two sentences — and should end with a period.
- Listed features must describe functionality the integration provides within Smile (not just general features of the third-party platform).
- Feature descriptions should not end with punctuation.
- The documentation link must go directly to a relevant article explaining how to use the integration, not a generic help center homepage.
- Documentation must clearly describe how merchants can connect and use the app’s core features.
Activities
Apps that create Smile activities (e.g., “made a purchase,” “wrote a product review”) must use clear, merchant-friendly naming conventions.
- Each activity’s “Name after completed” should be written in active voice and past tense to reflect the customer’s action.
- Activity names should be written in sentence case (capitalize only the first letter).
For example:
- ✅ Good: Made a purchase // ❌ Bad: Purchase made
- ✅ Good: Wrote a product review // ❌ Bad: Review submitted
- ✅ Good: Referred a friend // ❌ Bad: Friend referred
