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

RyderShip App Platform Installation

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

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

  • Application ID and Client Secret: Request API access from RyderShip by contacting your Onboarding Specialist or Customer Success Manager, or by submitting RyderShip's API access request form. RyderShip will issue you an Application ID (client ID) and Client Secret, along with a User Scope of either user_read or user_manage.

  • Refresh Token: RyderShip authenticates using OAuth2, so unlike a static API key, this requires a one-time manual authorization step to generate. See Complete the RyderShip authorization flow below.

The RyderShip integration authenticates via OAuth2 – unlike Klaviyo, WooCommerce, and ShipMonk, a manual authorization flow is required before you can install the app.

  1. In a browser, issue a GET request to /oauth/authorize on your RyderShip environment (Sandbox: https://sandbox.whiplash.app, Production: https://www.getwhiplash.com), including your scope, response_type=code, redirect_uri, and client_id as parameters.

  2. Log in with your RyderShip web app credentials. You'll be redirected to your redirect_uri with a code parameter appended. Retain this value.

  3. Make a POST request to /oauth/token with the code, your redirect_uri, client_id, client_secret, scope, and grant_type=authorization_code. The response includes an access_token and a refresh_token.

  4. Retain the refresh_token – this is the value you'll enter in the Gladly configuration form below.

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

  3. Fill in the configuration form:

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

  5. Application ID – your RyderShip application ID (client ID).

  6. Client Secret – your RyderShip client secret.

  7. Refresh Token – the refresh token you obtained by completing the authorization flow above.

  8. Save and activate the configuration.

That's it – the configuration is live. Continue to Enable RyderShip 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 RyderShip 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/rydership/v1.0.0" \
  --name "RyderShip" \
  --secrets '{"applicationId": "<application_id>", "clientSecret": "<client_secret>", "refreshToken": "<refresh_token>"}'

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/rydership/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 RyderShip Card in Customer Details and the relevant RyderShip 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 RyderShip credentials, see the RyderShip API authentication documentation.


Related docs