Configure an App

New
  • Published on May 29, 2025
  • 2 minute(s) read
Prev Next

Configuring an app

Glossary

As you will run below commands, it will be important to understand the following terms and how they will be used.

application identifier - e.g. gladly.com/shopify/v2.0.7

--name - this shows up in the UI and should have a helpful name. For example “Shopify Dev Store v3.0.4”. This name informs: what app it is, to which instance of the app the configuration connects to, which version of the app it is.

--activate - set this to true if you wish to immediately enable this configuration to begin servicing requests

Configure your app

Non-Oauth apps

appcfg apps config create <application identifier> \
--name "My Configuration" \
--config '{"non-secret":"configuration", "host":"www.example.com"}' \
--secrets '{"a-secret":"api-token"}' \
--activate

Tip

The —config flag is required even if the configuration is empty

Now an instance of the external app has been associated with the required configuration (such as API token stored on the configuration), and is officially ready for use. You can verify this by running the appcfg apps config list command:

appcfg apps config list                                                                                                                                                                         ✘ 1 
|     APP IDENTIFIER     |       CONFIG ID        |      CONFIG NAME      | CONFIG ACTIVE |  CONFIG CREATED AT  |  CONFIG UPDATED AT  |
|------------------------|------------------------|-----------------------|---------------|---------------------|---------------------|
| gladly.com/SKIO/v1.0.0 | YQ5YcTTVTPi5M3OAE0n6cA | Skio Partner Org v1.0 | Yes           | 2025-04-24 14:36:56 | 2025-04-24 14:36:56 |
|------------------------|------------------------|-----------------------|---------------|---------------------|---------------------|

Oauth

Registering your Oauth domain

Make sure that have contacted Gladly Support to register your Oauth domain before running the command below

  1. Create configuration

    appcfg apps config create <application identifier> /
--name "My Configuration" /
--config '{"non-secret":"configuration"}'
--secrets '{}'

  2. Authorize

    appcfg apps oauth "My Configuration"

Autocomplete

With autocomplete, hit Tab after appcfg apps config create, and it will pull up all installed apps that are ready for configuration. The list will filter on partial matches, i.e. typing the identifier partially:

> appcfg apps config create <hit tab>
App Platform Team/errors/v1.0.0         gladly.com/big_commerce/v1.0.8          gladly.com/big_commerce/v6.0.0          gladly.com/developer/v1.1.4             gladly.com/shopify/v1.0.3
gladly.com/big_commerce/v1.0.10         gladly.com/big_commerce/v1.0.9          gladly.com/big_commerce/v8.0.0          gladly.com/install-test-epsilon/v1.0.0  gladly.com/shopify/v1.0.4
gladly.com/big_commerce/v1.0.3          gladly.com/big_commerce/v2.0.0          gladly.com/developer/v1.0.0             gladly.com/install-test-epsilon/v1.2.4  gladly.com/shopify/v2.0.7
gladly.com/big_commerce/v1.0.4          gladly.com/big_commerce/v3.0.0

Updating config/Activate config

When you run appcfg apps config list you will see a column CONFIG ID, which can be used to activate your configuration when you are ready:

To activate:

appcfg apps config update <config-id> --activate

Related docs