Welcome to the Reverb API

Welcome to the Reverb developer hub. You'll find comprehensive guides and documentation to help you start working with Reverb as quickly as possible, as well as support if you get stuck.

Get Started

Build your first Reverb App

Welcome! This is a tutorial to get started building Reverb Apps!

What are Reverb Apps?

Broadly speaking, a Reverb App is any product that integrates with the Reverb API. More specifically, apps come in 3 flavors:

  1. Embedded Apps sold on Reverb App Store - These run within the Reverb UI and appear a seamless part of the Reverb experience to users. You build an app and host it at Reverb displays your app in an iFrame.
  2. External Apps sold on Reverb App Store - These are apps run on your website ( but still sold and promoted through the Reverb App store.
  3. E-commerce Integrations - These apps use the Reverb API but are typically implemented inside of other platforms and sold through other app stores. For example, our Shopify, Bigcommerce, and Magento integrations are external apps. The payments are handled through external app stores. To get your E-Commerce integration promoted at reverb, please contact us at [email protected].

Both Embedded and External Apps are sold through the Reverb App Store by charging users directly (as line items on their monthly statement). Developers don't have to worry about dealing with payments as the Reverb App Store will automatically charge users a monthly fee (set by the Developer) after a 30 day trial. Developers are paid 80% of the App's earnings.

How do I build an app?

Here are your basic steps:

  1. Create your app in any platform or language you like. The only requirement is that it's a web application that can be served in a web browser.
  2. Get Sandbox Access to test your app.
  3. Create the production version of your app
  4. Decide whether your app will be served embedded or standalone by clicking the checkbox on the form when creating your page.
  5. Integrate authentication into your app. If your app is going to be performing actions or pulling data for a particular user, you will have to implement an OAuth Flow: Apps for multiple users (OAuth2 Access Code Flow)
  6. When your app first loads, if the user is not logged in, you should immediately start an OAuth flow by redirecting them to Reverb - this way the first screen they see is a Reverb Permissions screen that allows them to install the app.
  7. Once the user is authenticated, you may store the token and use it to perform other requests with the API.

Where are some example apps?

Check out the Reverb App Store to see some examples. There are a handful of apps built by that are good examples.

Additional Resources

Updated less than a minute ago

Build your first Reverb App

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.