Documentation

Everything you need to get started with Revenue Shield

Documentation

Getting Started

Installation & Setup

Revenue Shield indexing a Shopify store after install, scanning collections, products, and checkout to discover monitoring targets
On install Revenue Shield indexes your store — no manual setup of selectors or fixtures.

This guide covers the full installation process, explains the permissions Revenue Shield requires, and walks through what happens during onboarding.

Prerequisites

  • An active Shopify store on any plan (including development stores on the Free plan)
  • Admin or staff access with permission to install apps
  • A modern web browser (Chrome, Firefox, Safari, or Edge)

Installation Steps

1. Find Revenue Shield

Search for "Revenue Shield" in the Shopify App Store, or use the direct install link provided on the Revenue Shield website. Click Add app to begin.

2. Review and Approve Permissions

Revenue Shield requests two Shopify API scopes:

  • read_products — Used to read your product catalog, collections, and store structure during OOTB test generation. This allows the system to identify real products and collections to include in automated tests.
  • write_products — Required by the Shopify embedded app framework for full app functionality. Revenue Shield does not create, modify, or delete any products in your store.

Click Install app to approve and proceed.

3. Onboarding

After installation, Revenue Shield automatically runs the onboarding process:

  1. Reads your store's product and collection data via the Shopify API
  2. Generates five OOTB checkout flow tests tailored to your store's structure
  3. Configures the default test schedule based on your plan
  4. Runs the first test suite to establish a baseline

Onboarding typically completes in under 60 seconds. You will see test results appear on your dashboard as soon as the first run finishes.

Initial Configuration

Alert Channels

By default, email alerts are sent to the address associated with your Shopify account. Additional channels can be configured in Settings → Notifications:

  • Email — Add multiple recipient addresses
  • Slack — Provide an incoming webhook URL to route alerts to a specific channel
  • SMS — Enter a phone number with country code

Test Schedule

The default cadence depends on your plan. You can adjust the schedule in Settings → Scheduling. Available cadences range from every 15 minutes (Agency) to every 8 hours (Free). See Test Scheduling for full details.

Timezone

Revenue Shield detects your store's timezone from Shopify settings. You can override this in the scheduling configuration if needed.

Embedded App

Revenue Shield runs as an embedded Shopify app. The dashboard, settings, and test results are all accessible directly within your Shopify admin panel. There is no separate login or external portal to manage (unless you are using the Agency plan's multi-store dashboard).

Troubleshooting

App Will Not Install

  • Confirm you have admin or appropriate staff permissions on the Shopify store
  • Try clearing your browser cache or using an incognito window
  • Contact support at support@getrevenueshield.com with your store URL

Tests Not Generating

  • Ensure your store has at least one published product and one collection
  • Check that the store is not password-protected (Revenue Shield must access the storefront)
  • Wait 60 seconds and refresh the dashboard

Uninstallation

To remove Revenue Shield, go to Shopify Admin → Settings → Apps and sales channels, find Revenue Shield, and click Uninstall. All test data, history, and stored artifacts will be permanently deleted.

Need Help?

Can't find what you're looking for? Our team is here to help.