App Installation

Overview of the Gobo app installation flow.

Gobo manages all aspects of app installation. Customerusers can install apps created by your partnerorgs into their customerorgs. Once installed, apps can obtain an access token from Gobo and begin making requests to your API(s).

Installation Flow

When creating your app, you can register an install URL. This is the URL where your customers are redirected after completing the app installation flow.

Steps:

1. Customeruser installs apps and approves scopes (if present)

2. Gobo redirects to the app's install URL

3. The app makes a request to Gobo's OAuth endpoints to obtain an access token

4. The app redirects back to your app marketplace when complete

Gobo App Installation

Install URL

Once an app is installed, the customeruser is redirected to your app's install URL. This is the moment when you should sign up users if they do not already have an account with your app, authenticate them into various systems, and configure your app.

Installation metadata is passed along as query parameters to the install URL to aid in obtaining access tokens, making API calls, and presenting relevant content to app users.

Install URL

https://{install_url/?target={customerorg_guid}&target_id={customerorg_external_id}

Marketplace Redirect

When you have completed any necessary installation steps, you should redirect the customeruser back to the marketplace using the redirect URL below. You should also pass along the appropriate query parameter to denote the installation as successful or to present an error message.

Successful Installation

https://{marketplace_url}/redirect?install_success=true

Installation Error

https://{marketplace_url}/redirect?error_message={SOME_MESSAGE_TO_SHOW}