Weebly is known for ease-of-use and a great user experience, and we want to ensure that only the highest quality apps are listed in the Weebly App Center. All apps posted in the center need to follow specific requirements so that our customers experience a consistent standard of excellence. We review every app for adherence to these requirements, and ask for revisions when a requirement isn’t quite met.

This page lists the requirements your app must adhere to in order to be included in the App Center. The details are linked to and included throughout the documentation. We also provide a checklist you can use before you submit your app for our review.

General Requirements

All apps, elements, themes, and any other partner integration with Weebly must abide by the Weebly App Developer Agreement and the Weebly API Terms of Use. Be sure to read these carefully before, and as, you design your app.

Most important of these is that your app cannot be an infringement on any copyright, trademark, patent, or trade secret of any party.

You can create apps that offer similar functionality to what Weebly provides. However, if the Weebly functionality requires a premium plan, then your app may require the same Weebly plan.

Overall Quality and Usefulness

Weebly customers expect their website to be easy to build and maintain. Same goes for any apps or elements that they incorporate into their site. Follow these parameters to ensure your app will be added to our App Center.

Testing

We’ll be testing your app before we release it for publication, so if your app requires a user account, we’ll need test account information. You can enter this info when you create your App Card. We’ll test your app throughout its lifespan, so you need to keep this account active for us as long as the app is in the App Center.

And speaking of testing, your app must be fully tested and free of bugs before you submit it to us. We’ll report small issues to you, but we’ll stop testing if we find major bugs. Always make sure you test your app in a variety of browsers and in a site using a variety of Weebly themes (more on that, below). If your app includes a dashboard card or a demo site, we’ll test those as well.

UX

Your app needs to have a high level of polish and an easy, intuitive user experience. We’ll ask you to fix any confusing flows or interactions.

Usefulness

Your app must appeal to a broad range of Weebly customers, for example, a widget to keep track of something on a site. And even an app that targets a specific group of people is fine, as long as it’s a large common group of people. For example, we’d accept an app for Real Estate sites. If your app includes a dashboard card, that card needs to be useful, dynamic, and provide site-specific information.

Onboarding

Apps must have an easy onboarding flow that guides the user through the setup process, if applicable. You can provide this content in your app page images that are displayed in the App Center, or if your app is or contains an element and is fairly complicated, you can provide tooltips for its settings. Or you can create a tutorial that has information, procedures, or even a video! If your app requires the user to visit your site to configure and manage the app, you can create a manage link, or, if the user may have to do this on an on-going basis, consider creating a dashboard card. You can even create a demo site to showcase your app!

User Authentication, API Access, and Billing

An OAuth2 flow provides authentication communication between your app and Weebly. Use of this OAuth process is mandatory if your app requires any of the following:

  • Authenticating a user at your site If a user will need to create an account with you or sign into an account at your site, then you must implement that authentication using the OAuth flow. When designing your app, don’t have the user log in or create an account from the editor or from element settings. Instead, use the Weebly API to authenticate.
  • Accessing the Weebly API and webhooks Your app will need a token in order to access our APIs. You get this token at the end of the OAuth flow, which is kicked off when the site owner starts the install of your app. Once you receive the token, you can access the API. More here.
  • Accessing your site from Weebly Additionally, if your app uses external settings, a dashboard card with external content in a takeover, or a manage URL that directs a user to your site, that URL must use the https protocol.
  • ​Reporting payment Apps that charge money must use Weebly’s Payment Notifications API to report all payments and refunds, including one-time payments, monthly subscriptions, upgrades, downgrades, cancellations, etc. You’ll need to have the OAuth token to access that API. Make sure to use the testpayment and testrefund methods prior to releasing your app.

Design and User Experience

Integration with Weebly

Your app must directly integrate with Weebly. You can do this by creating an element that users drop onto a page to insert your app. Or you might access our APIs to work with the user’s site by creating a snippet that gets installed on every page or by developing a backend service that integrates directly via the API.

Multiple Sites

Many Weebly users own more than one site, so your app has to be able to work in that situation. We recommend that you create a one-to-one relationship between a Weebly user and a user account on your side, and that you then support multiple sites for a single user. If you absolutely can’t support multiple sites, then create a new user on your end for each combination of a Weebly user and a Weebly site.

Element Configuration

Elements should use the native element settings functionality for any configuration. Review existing Weebly elements and design guidelines to get a better understanding of the Weebly conventions. If you must use external settings, or include a dashboard card takeover, the content must load quickly and have a loading indicator. Using a fullscreen window should be avoided unless absolutely necessary. All in-code URLs must use the HTTPS protocol.

Element Icons

Elements are displayed to the user as icons in the Element Tray of the Weebly Editor. The design of your icon needs to portray its functionality so that the user can quickly understand what it provides. There are strict specifications for icon design - be sure to follow them!

Tutorials

Element tutorials provide a way to help users get started with your app. Not all apps need a tutorial, only those where the customer may not be able to fully use the app without help. Tutorials can include stepped procedures and videos, but may not contain any promotional material. They must be strictly educational in nature.

Look and Feel

Themes

Always design with the knowledge that site owners can use any theme, or even create their own, and then change it at any time. Apps must look and work well in all kinds of themes, both light and dark. There are specific classes that you’ll need to use in your HTML so that your app looks good and doesn’t loose any functionality, no matter the theme.

Different Devices

Weebly sites are often viewed on both desktop and mobile devices. Some of our themes are responsive, while others are not. You need to design and implement your app so that it works in both types of sites. If there’s a chance that your app might be used in a sidebar or in a column, you’ll need to design and test with resizing in mind.

App Functionality

Security

Apps must function on both SSL and non-SSL sites.

Browser Support

Your app needs to function correctly in the following browsers, in both the editor and in a published site:

  • Internet Explorer 11 and newer
  • Most recent version of all self-updating (evergreen) browsers

Using Global JavaScript Variables

Weebly uses both jQuery and Underscore libraries in the editor and on live sites. If your app also needs to use these libraries, do not expose any global variables, including jQuery or Underscore, as conflicts may arise.

Flash-y Behavior

Your app should not use plug-in support, like Adobe Flash or Microsoft Silverlight. If it absolutely needs it, contact dev-support@weebly.com.

Distracting behavior or behavior that is outside the Weebly paradigm will confuse and frustrate users. So please don’t display ads or use alerts and confirmation boxes.

App Management

You can configure your app so that once a user installs it, they can visit the App Center and click a link to manage it. If you decide to allow this, please make sure the page they are directed to allows them to directly manage their app. Don’t direct them to a landing page and make them hunt for the content they need. Additionally, you can create a dashboard card that allows the user to manage your app.

App Center Listing

Once your app is reviewed and approved, it will be posted to the App Center. You use the Dev Admin portal to configure the app page, pricing, app card, and developer card that are used to promote your app in the center. You can also create a demo site to showcase your app on a live site. You must follow the guidelines when creating these assets.

Post Publication

App Announcement

Any press releases for your app must first be reviewed by Weebly. Send a draft to weebly-bd@squareup.com prior to releasing.

App Support

Apps must supply at least one support method (email, phone, or website) for users to contact, unless the app is completely free (you provide this contact info when you create your App Center listing). The Weebly Customer Support team will direct any questions specific to your app to the contact information you’ve provided.

If major problems are found with your app after it has been approved, Weebly may pull your app from the App Center until the problem is resolved. While this will prevent new users from installing the app, the broken app may still be present on all existing users’ published sites. Therefore, it is essential that you respond to any emails from the Weebly team and provide updates as to when the problem will be resolved. To proactively report problems, please contact dev-support@weebly.com.

App Reviews

Weebly users that install your app can leave a review. How you manage these reviews, especially negative ones, can greatly impact how well your app will do in the App Center. We provide guidelines for handling comments. Adherence to these guidelines, especially when receiving negative comments and reviews, ensures your app can remain in the App Center.

App Updates

Once your app has been approved and published in the App Center, the real fun begins: listening to your users and making your app even better! We encourage you to submit periodic updates to your app with bugfixes, new features, and general improvements.

App Payment

If you charge customers for your app, you need to report your revenue to Weebly. We provide an API that you can use, so be sure to create test payments and refunds before submitting your app for review. We also provide a payment log where you can review, and if needed, correct those payment records.


Help make these docs better!