Public preview

Handle different modes Public preview

Adapt your app to handle live mode and sandboxes.

During installation, users can choose which environment to install your app into.

Try it in a sandbox

In the App Marketplace, potential users see a Try it in a sandbox option to encourage them to try out an app.

Caution

If your app uses the OAuth API access type or an external install URL, you won’t see the Try it in a sandbox option in the App Marketplace.

Install shortcut

If the app is installed in one environment, you can install it in another environment from the Stripe Dashboard.

Webhooks

If your app is set up to listen to events for your installed users’ accounts, it requires additional setup to make sure you can handle having your app installed in test mode sandboxes and general sandboxes.

If a user installs your app in live mode only, Stripe sends applicable live-mode events to your live-mode webhook endpoints.
If a user installs your app in a test mode sandbox only, Stripe sends applicable test mode sandbox events to your test mode sandbox webhook endpoints.
If a user installs your app in both live mode and a test mode sandbox, Stripe sends test mode sandbox events to your test mode sandbox and live-mode webhook endpoints, and it sends live-mode events only to your live-mode webhook endpoints.
If a user installs your app in a sandbox environment, Stripe sends events only to the webhook endpoints for that sandbox.

Note

Set up live mode, test mode sandbox and general sandbox webhook endpoints to make sure all environments are properly supported. See event behaviour for more information and examples about how the install mode affects event behaviour.

OAuth links

OAuth apps initiate app installation from within your platform. You’re responsible for implementing install links for test mode sandbox and general sandbox support.

The Stripe Dashboard provides OAuth install links for test mode sandboxes and general sandboxes.

The Stripe Apps OAuth documentation has more information on creating OAuth install links.