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

WooCommerce App Platform Installation

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

Review the following information before you install the WooCommerce 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 WooCommerce credentials – both installation methods below need the same values from your WooCommerce store:

  • Consumer Key and Consumer Secret: In WordPress, go to WooCommerce → Settings → Advanced → REST API, then select Create an API key (or Add Key). Assign the key to a user. Read permission is sufficient. Select Generate API Key. Copy the Consumer Key and Consumer Secret shown on the confirmation screen.

    • Note: the Consumer Secret is shown only once – copy and store it in a safe place before leaving the page.

  • Store URL: Your WooCommerce store hostname, without https:// (e.g. mystore.com). This is used to route API calls to the correct site.

The WooCommerce integration authenticates with a Consumer Key and Consumer Secret – no separate OAuth flow is required for stores running over HTTPS.

There are two ways to install and configure WooCommerce. 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 WooCommerce from the list of available apps.

  3. Fill in the configuration form:

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

  5. Store URL – the store hostname you gathered above, without https:// (e.g. mystore.com).

  6. Consumer Key – your WooCommerce REST API consumer key.

  7. Consumer Secret – your WooCommerce REST API consumer secret.

  8. Save and activate the configuration.

Configuration settings for connecting Gladly to WooCommerce and REST API credentials.

That's it – the configuration is live. Continue to Enable WooCommerce 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 WooCommerce 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/woocommerce/v1.0.1" \
  --name "WooCommerce" \
  --config '{"storeUrl": "<store_url>"}' \
  --secrets '{"consumerKey": "<consumer_key>", "consumerSecret": "<consumer_secret>"}'

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/woocommerce/v1.0.1"

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 WooCommerce Card in Customer Details and the relevant WooCommerce 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 WooCommerce credentials, see the WooCommerce REST API documentation.


Related docs