Documentation Index

Fetch the complete documentation index at: https://help.gladly.com/llms.txt

Use this file to discover all available pages before exploring further.

We're updating help docs to reflect our new product naming. Gladly Sidekick (AI) is now called just Gladly, and Gladly Hero (the Platform) is now Gladly Team. Some articles may display outdated names while we update everything. Thank you for your patience! Learn more

  • Product Docs
  • Implementation
  • Developer Tutorials

Shipmonk App Platform Installation

  • Published on Jul 21, 2026
  • 2 minute(s) read
Prev Next

Review the following information before you install the ShipMonk app.

  • Review the App Platform overview and key concepts to familiarize yourself with this tool before the installation.

  • You need to have Administrator permission in order to complete the installation process.

Gather your ShipMonk credentials – both installation methods below need the same value from your ShipMonk account:

  • API Key: In ShipMonk, go to Account Settings → General Settings → Stores. If you don't already have a ShipMonk API Store, select Integrate Another Store and complete the Typeform – ShipMonk's integrations team will reach out within 48 hours to finish setting up your store. Once your store is authorized, go to Integration API Keys and select Create API Key. Copy the key.

    • Note: save the API Key somewhere secure – if it's lost, you'll need to generate a new one.

The ShipMonk integration authenticates with an API key, sent as the Api-Key header on every request – no OAuth flow is required.

There are two ways to install and configure ShipMonk. Installing in Gladly (Option A) is the recommended path for most customers – it requires no command-line tooling.

  1. In Gladly, go to Apps → Create Configuration.

  2. Select ShipMonk from the list of available apps.

  3. Fill in the configuration form:

  4. Configuration Name – a recognizable name for this configuration (e.g. "ShipMonk Production").

  5. API Key – your ShipMonk API key.

  6. Save and activate the configuration.

Configuration settings for connecting Gladly to an external app like Shopify.

That's it – the configuration is live. Continue to Enable ShipMonk in Gladly Team below.

Use this method if you prefer to manage configurations from the command line. You'll need a technical resource who can run the appcfg CLI and has access to both your Gladly and ShipMonk instances.

  1. Install the App Platform CLI Tool

Install the App Platform CLI (appcfg), which allows you to manage and configure all your App Platform apps. Follow the setup instructions here: Install appcfg.

2. Obtain Your Gladly API Credentials

You'll need the following to authenticate with your Gladly instance:

  • Gladly Host:

    • us-1.gladly.com for Production

    • us-uat.gladly.qa for Sandbox

  • Gladly User: The email of a Gladly user with Administrator or API User permissions

  • Gladly API Token: A personal API token for the user above

To generate your token, follow Gladly's API Token documentation. Once you have these, set them as environment variables for convenience:

export GLADLY_APP_CFG_HOST="us-1.gladly.com"   # or us-uat.gladly.qa for Sandbox
export GLADLY_APP_CFG_USER="your.email@company.com"
export GLADLY_APP_CFG_TOKEN="your-api-token-here"

  1. Create the Configuration

Run the following command to configure the app:

appcfg apps config create "gladly.com/shipmonk/v1.0.0" \
  --name "ShipMonk" \
  --secrets '{"apiKey": "<shipmonk_api_key>"}'

Always install the latest available version of the app. You can check the latest version using appcfg apps list.

4. List Configurations to Get Your Configuration ID

appcfg apps config list --identifier "gladly.com/shipmonk/v1.0.0"

Note the CONFIG ID from the output – you'll need it for the next step.

5. Activate Your Configuration

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

Both the ShipMonk Card in Customer Details and the relevant ShipMonk action(s) in the + menu must be enabled by Gladly before they appear in the agent desktop. Once your configuration is active, reach out to Gladly Support to enable the Card and any related actions for your team.

For more details on configuration and credential structure, refer to the app-platform-examples repository. You can always clone it and adapt it to your needs.

For instructions on getting ShipMonk credentials, see the ShipMonk API documentation.


Related docs